gitlogstats 1.2.0__tar.gz → 1.3.0__tar.gz

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: gitlogstats
-Version: 1.2.0
+Version: 1.3.0
 Summary: Track developers' contributions to one or more git repositories within a particular time range.
 Project-URL: Homepage, https://github.com/bloombar/gitlogstats
 Project-URL: Repository, https://github.com/bloombar/gitlogstats.git
@@ -752,9 +752,9 @@ options:
   -v, --verbose         Whether to output debugging info
   -c, --clean           Remove contributors without any contribuition
   --github              Also report GitHub pull requests opened, merged,
-                        closed and self-merged per contributor, and match
-                        GitHub users to git authors. Needs the GitHub CLI
-                        (gh), signed in
+                        closed and self-merged per contributor, with their git
+                        and GitHub emails, and match GitHub users to git
+                        authors. Needs the GitHub CLI (gh), signed in
 ```
 
 In case `gitlogstats` is not found as a command, even after installing, try `python -m gitlogstats` or `python3 -m gitlogstats` instead.
@@ -837,7 +837,7 @@ gitlogstats -rf repos.txt -c
 
 ### GitHub pull requests
 
-Add `--github` to also count each contributor's pull requests. Five columns are appended to every output format:
+Add `--github` to also count each contributor's pull requests. Seven columns are appended to every output format:
 
 | Column                | Meaning                                                                                                 |
 | --------------------- | ------------------------------------------------------------------------------------------------------- |
@@ -846,6 +846,8 @@ Add `--github` to also count each contributor's pull requests. Five columns are
 | `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too)   |
 | `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                          |
 | `prs_self_merged`     | pull requests they authored and also merged themselves, merged in the date range (also in `prs_merged`) |
+| `git_email`           | every distinct author email of the git names combined into the row, sorted alphabetically (ignoring case) and separated by `; `; empty for a GitHub-only row |
+| `github_email`        | the public email on the matched GitHub profile; empty when the profile has none (GitHub does not reveal private emails) or no account matched |
 
 ```
 gitlogstats -r https://github.com/bloombar/gitlogstats.git --github
@@ -858,7 +860,7 @@ gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install
 gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.
 ```
 
-**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics.
+**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics. When GitHub could not be asked, `git_email` is still filled in and `github_email` is empty. The emails come from the whole history of the branch, not only from commits in the date range.
 
 **Matching GitHub users to git authors.** Each git author name is compared with the GitHub users active in the repository, trying these in order and stopping at the first that finds exactly one user:
 

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/README.md

@@ -55,9 +55,9 @@ options:
   -v, --verbose         Whether to output debugging info
   -c, --clean           Remove contributors without any contribuition
   --github              Also report GitHub pull requests opened, merged,
-                        closed and self-merged per contributor, and match
-                        GitHub users to git authors. Needs the GitHub CLI
-                        (gh), signed in
+                        closed and self-merged per contributor, with their git
+                        and GitHub emails, and match GitHub users to git
+                        authors. Needs the GitHub CLI (gh), signed in
 ```
 
 In case `gitlogstats` is not found as a command, even after installing, try `python -m gitlogstats` or `python3 -m gitlogstats` instead.
@@ -140,7 +140,7 @@ gitlogstats -rf repos.txt -c
 
 ### GitHub pull requests
 
-Add `--github` to also count each contributor's pull requests. Five columns are appended to every output format:
+Add `--github` to also count each contributor's pull requests. Seven columns are appended to every output format:
 
 | Column                | Meaning                                                                                                 |
 | --------------------- | ------------------------------------------------------------------------------------------------------- |
@@ -149,6 +149,8 @@ Add `--github` to also count each contributor's pull requests. Five columns are
 | `prs_merged`          | pull requests they authored that were merged in the date range, by anyone and in any way (squash too)   |
 | `prs_closed_unmerged` | pull requests they authored that were closed without merging in the date range                          |
 | `prs_self_merged`     | pull requests they authored and also merged themselves, merged in the date range (also in `prs_merged`) |
+| `git_email`           | every distinct author email of the git names combined into the row, sorted alphabetically (ignoring case) and separated by `; `; empty for a GitHub-only row |
+| `github_email`        | the public email on the matched GitHub profile; empty when the profile has none (GitHub does not reveal private emails) or no account matched |
 
 ```
 gitlogstats -r https://github.com/bloombar/gitlogstats.git --github
@@ -161,7 +163,7 @@ gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install
 gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.
 ```
 
-**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics.
+**Empty versus zero.** A zero means GitHub was asked and the person has none. An empty value (`null` in JSON) means GitHub could not be asked for that repository: it is not on github.com, or the request failed (no network, rate limit, a private repository you cannot see). The git statistics are still reported, the reason is printed to standard error, and the other repositories carry on. A contributor with no GitHub account matched has an empty `github_username` and zero pull requests. A GitHub user who opened pull requests but has no commits is listed in a row of their own with an empty `username` and zero git statistics. When GitHub could not be asked, `git_email` is still filled in and `github_email` is empty. The emails come from the whole history of the branch, not only from commits in the date range.
 
 **Matching GitHub users to git authors.** Each git author name is compared with the GitHub users active in the repository, trying these in order and stopping at the first that finds exactly one user:
 

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/docs/SPEC.md

@@ -120,6 +120,12 @@ With `--github`, for each contributor, the number of pull requests they authored
 
 **Status:** Done
 
+#### STAT-13 Contributor email addresses
+
+With `--github`, every row also reports the contributor's email addresses in two columns appended after `prs_self_merged`: `git_email` lists every distinct author email of the git identities combined into the row (STAT-11), sorted alphabetically (ignoring case) and separated by `; `, and is empty for a GitHub-only row; `github_email` is the public email on the matched GitHub user's profile, and is empty when the profile has none (GitHub does not reveal private emails) or the row has no GitHub user. Emails come from the whole history of the analyzed branch, like the contributor list, not only from commits in the date range. When GitHub statistics are unavailable for a repository (CLI-3), `git_email` is still filled in and `github_email` is empty (`null` in JSON). Without `--github`, neither column appears.
+
+**Status:** Done
+
 ### 3. Filtering
 
 #### FILT-1 Date range
@@ -150,7 +156,7 @@ By default, contributors with no activity in the date range are listed with zero
 
 #### OUT-1 CSV output
 
-`-f csv` (the default) prints a header row followed by one row per contributor per repository, with fields `username, repository, start_date, end_date, commits, insertions, deletions, files, merges`. New fields are added at the end so existing column positions do not change. Values containing commas, quotes or line breaks are quoted. The header is printed even when there are no rows, and the output ends with a single newline. With `--github`, the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged` are appended, and are in the header even when there are no rows (CLI-3).
+`-f csv` (the default) prints a header row followed by one row per contributor per repository, with fields `username, repository, start_date, end_date, commits, insertions, deletions, files, merges`. New fields are added at the end so existing column positions do not change. Values containing commas, quotes or line breaks are quoted. The header is printed even when there are no rows, and the output ends with a single newline. With `--github`, the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged, git_email, github_email` are appended, and are in the header even when there are no rows (CLI-3).
 
 **Status:** Done
 
@@ -194,12 +200,12 @@ Invalid dates, and a start date after the end date, are rejected with a usage er
 
 #### CLI-3 GitHub pull-request statistics
 
-`--github` adds GitHub pull-request statistics (STAT-8 to STAT-12) for repositories hosted on github.com, appending the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged` to every output format. Without `--github`, the output and behaviour are unchanged, GitHub is never contacted and the GitHub CLI (`gh`) is not needed. With `--github`, the GitHub API is called through `gh api`, so `gh` must be installed and signed in. This is checked before any repository is cloned; if it fails, nothing is printed to standard output, the tool exits with status 1, and one plain message on standard error says why and what to do — no stack trace:
+`--github` adds GitHub pull-request statistics (STAT-8 to STAT-12) and contributor emails (STAT-13) for repositories hosted on github.com, appending the columns `github_username, prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged, git_email, github_email` to every output format. Without `--github`, the output and behaviour are unchanged, GitHub is never contacted and the GitHub CLI (`gh`) is not needed. With `--github`, the GitHub API is called through `gh api`, so `gh` must be installed and signed in. This is checked before any repository is cloned; if it fails, nothing is printed to standard output, the tool exits with status 1, and one plain message on standard error says why and what to do — no stack trace:
 
 - `gh` not found: `gitlogstats: --github needs the GitHub CLI (gh), which is not installed. Install it from https://cli.github.com and run 'gh auth login', or run without --github.`
 - `gh` not signed in (`gh auth status` fails): `gitlogstats: --github needs the GitHub CLI (gh) to be signed in. Run 'gh auth login', or run without --github.`
 
-The other options apply to pull requests as follows: `-s/-e` filter each count by its own timestamp, using the same inclusive local-time range as FILT-1; `-u` selects the combined row whose author names, emails or GitHub username match exactly (the username ignoring case); `-b` counts only pull requests whose base branch is that branch, and without `-b` every pull request counts; `-c` removes only rows with neither git nor pull-request activity; `-x` does not apply. For a repository not on github.com, or when GitHub cannot be reached for one repository (no network, rate limit, private repository without access), the git statistics are still reported, the five GitHub columns are empty (`null` in JSON) rather than zero, and the reason is printed to standard error.
+The other options apply to pull requests as follows: `-s/-e` filter each count by its own timestamp, using the same inclusive local-time range as FILT-1; `-u` selects the combined row whose author names, emails or GitHub username match exactly (the username ignoring case); `-b` counts only pull requests whose base branch is that branch, and without `-b` every pull request counts; `-c` removes only rows with neither git nor pull-request activity; `-x` does not apply. For a repository not on github.com, or when GitHub cannot be reached for one repository (no network, rate limit, private repository without access), the git statistics are still reported, the GitHub columns (including `github_email`) are empty (`null` in JSON) rather than zero while `git_email` is still filled in (STAT-13), and the reason is printed to standard error.
 
 **Status:** Done
 

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "gitlogstats"
 description = "Track developers' contributions to one or more git repositories within a particular time range."
-version = "1.2.0"
+version = "1.3.0"
 authors = [
   { name="Tobody Tothing", email="nobody.nothing@nowhere.com" },
 ]

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/scripts/board/manifest.yaml

@@ -19,16 +19,16 @@
   status: Done
 - id: CLI-3
   title: GitHub pull-request statistics
-  full: "--github adds GitHub pull-request statistics (STAT-8 to STAT-12) for
-    repositories hosted on github.com, appending the columns github_username,
-    prs_opened, prs_merged, prs_closed_unmerged, prs_self_merged to every output
-    format. Without --github, the output and behaviour are unchanged, GitHub is
-    never contacted and the GitHub CLI (gh) is not needed. With --github, the
-    GitHub API is called through gh api, so gh must be installed and signed in.
-    This is checked before any repository is cloned; if it fails, nothing is
-    printed to standard output, the tool exits with status 1, and one plain
-    message on standard error says why and what to do — no stack trace: gh not
-    found: gitlogstats: --github…"
+  full: --github adds GitHub pull-request statistics (STAT-8 to STAT-12) and
+    contributor emails (STAT-13) for repositories hosted on github.com,
+    appending the columns github_username, prs_opened, prs_merged,
+    prs_closed_unmerged, prs_self_merged, git_email, github_email to every
+    output format. Without --github, the output and behaviour are unchanged,
+    GitHub is never contacted and the GitHub CLI (gh) is not needed. With
+    --github, the GitHub API is called through gh api, so gh must be installed
+    and signed in. This is checked before any repository is cloned; if it fails,
+    nothing is printed to standard output, the tool exits with status 1, and one
+    plain message on standard error says why and what to do…
   section: §5 Command-Line Interface
   family: CLI
   phase: 1
@@ -89,8 +89,8 @@
     containing commas, quotes or line breaks are quoted. The header is printed
     even when there are no rows, and the output ends with a single newline. With
     --github, the columns github_username, prs_opened, prs_merged,
-    prs_closed_unmerged, prs_self_merged are appended, and are in the header
-    even when there are no rows (CLI-3).
+    prs_closed_unmerged, prs_self_merged, git_email, github_email are appended,
+    and are in the header even when there are no rows (CLI-3).
   section: §4 Output
   family: OUT
   phase: 1
@@ -348,6 +348,22 @@
   family: STAT
   phase: 1
   status: Done
+- id: STAT-13
+  title: Contributor email addresses
+  full: "With --github, every row also reports the contributor's email addresses
+    in two columns appended after prs_self_merged: git_email lists every
+    distinct author email of the git identities combined into the row (STAT-11),
+    sorted alphabetically (ignoring case) and separated by ; , and is empty for
+    a GitHub-only row; github_email is the public email on the matched GitHub
+    user's profile, and is empty when the profile has none (GitHub does not
+    reveal private emails) or the row has no GitHub user. Emails come from the
+    whole history of the analyzed branch, like the contributor list, not only
+    from commits in the date range. When GitHub statistics are unavailable for a
+    repository (CLI-3), git_email is…"
+  section: §2 Contribution Statistics
+  family: STAT
+  phase: 1
+  status: Done
 - id: FUTURE-author-date-filtering
   title: Author-date filtering
   full: Author-date filtering — offer filtering by author date, so rebased or

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/src/gitlogstats/__main__.py

@@ -6,7 +6,7 @@ import re
 import sys
 from . import GitLogsParser
 from .git_logs_parser import FIELDNAMES
-from .github import GITHUB_FIELDNAMES, GitHubUnavailable, check_gh
+from .github import EMAIL_FIELDNAMES, GITHUB_FIELDNAMES, GitHubUnavailable, check_gh
 from .github_stats import github_rows
 
 
@@ -142,8 +142,8 @@ def main():
     parser.add_argument(
         "--github",
         help="Also report GitHub pull requests opened, merged, closed and "
-        "self-merged per contributor, and match GitHub users to git authors. "
-        "Needs the GitHub CLI (gh), signed in",
+        "self-merged per contributor, with their git and GitHub emails, and "
+        "match GitHub users to git authors. Needs the GitHub CLI (gh), signed in",
         default=False,
         action="store_true",
     )
@@ -233,7 +233,9 @@ def main():
     # emit a single table (or JSON array) covering all repositories
     if last_parser is not None:
         # an empty CSV table still gets the GitHub columns with --github
-        fieldnames = FIELDNAMES + GITHUB_FIELDNAMES if args.github else None
+        fieldnames = (
+            FIELDNAMES + GITHUB_FIELDNAMES + EMAIL_FIELDNAMES if args.github else None
+        )
         output = last_parser.format_results(all_results, args.format, fieldnames)
         # end with exactly one newline: CSV and Markdown output already has one
         print(output, end="" if output.endswith("\n") else "\n")

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/src/gitlogstats/github.py

@@ -21,6 +21,9 @@ GITHUB_FIELDNAMES = [
     "prs_self_merged",
 ]
 
+# STAT-13: the email columns that follow the pull-request columns
+EMAIL_FIELDNAMES = ["git_email", "github_email"]
+
 # CLI-3: the two user-facing messages, verbatim from the SPEC
 GH_NOT_INSTALLED = (
     "gitlogstats: --github needs the GitHub CLI (gh), which is not installed. "

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/src/gitlogstats/github_stats.py

@@ -87,10 +87,35 @@ def combine(parser, rows, identities, github_repo, args):
         parser.verboseprint(f"GitHub ambiguous: {name} ({', '.join(tiers)})")
     for name in sorted(set(identities) - set(matches)):
         parser.verboseprint(f"GitHub unmatched: {name}")
-    parser.verboseprint(f"GitHub API calls: {api_calls}")
 
+    # STAT-13: public emails of the matched users; a matched user who was not
+    # a candidate (found through a linked email) has a profile fetched now
+    github_emails = {
+        login: (info or {}).get("email") for login, info in candidates.items()
+    }
+    known = {login.casefold() for login in candidates}
+    for login, _tier in matches.values():
+        if login.casefold() in known:
+            continue
+        known.add(login.casefold())
+        api_calls += 1
+        try:
+            github_emails[login] = user_profile(login)["email"]
+        except GitHubError as exc:
+            if "(HTTP 404)" not in str(exc):
+                raise
+    parser.verboseprint(f"GitHub API calls: {api_calls}")
     repository = GitLogsParser.repo_name_from_url(parser.repository)
-    combined = consolidate(rows, matches, pr_counts, repository, args.start, args.end)
+    combined = consolidate(
+        rows,
+        matches,
+        pr_counts,
+        repository,
+        args.start,
+        args.end,
+        identities,
+        github_emails,
+    )
     return combined, matches
 
 
@@ -143,7 +168,9 @@ def github_rows(parser, rows, repo_url, identities, args):
         result, matches = combine(parser, rows, identities, github_repo, args)
     except GitHubError as exc:
         warn(repo_url, exc)
-        result = [unavailable_row(row) for row in rows]
+        result = [
+            unavailable_row(row, identities.get(row["username"], ())) for row in rows
+        ]
 
     if args.user:
         result = [r for r in result if keep_user(r, args.user, matches, identities)]

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/src/gitlogstats/identity.py

@@ -9,7 +9,7 @@ import re
 import unicodedata
 
 from gitlogstats.git_logs_parser import FIELDNAMES
-from gitlogstats.github import GITHUB_FIELDNAMES
+from gitlogstats.github import EMAIL_FIELDNAMES, GITHUB_FIELDNAMES
 
 NOREPLY_RE = re.compile(
     r"^(?:\d+\+)?([^@+\s]+)@users\.noreply\.github\.com$", re.IGNORECASE
@@ -165,16 +165,34 @@ def match_identities(identities, candidates, linked_emails):
     return matches, ambiguous
 
 
+def join_emails(emails):
+    """
+    STAT-13: list email addresses for the git_email column.
+    @param emails: an iterable of email addresses (empty ones are ignored).
+    @returns: the distinct addresses (ignoring case; the first in plain
+        sorted order is kept) sorted ignoring case and joined with "; ".
+    """
+    unique = {}
+    for email in sorted(set(emails)):
+        if email:
+            unique.setdefault(email.casefold(), email)
+    return "; ".join(unique[key] for key in sorted(unique))
+
+
 def _blank_row(row):
     """Return a copy of a git row in output column order, GitHub columns unset."""
     out = {field: row[field] for field in FIELDNAMES}
     out["github_username"] = ""
     for field in _PR_FIELDS:
         out[field] = 0
+    out["git_email"] = ""
+    out["github_email"] = ""
     return out
 
 
-def consolidate(rows, matches, pr_counts, repository, start, end):
+def consolidate(
+    rows, matches, pr_counts, repository, start, end, identities, github_emails
+):
     """
     Merge git rows that belong to one GitHub user and add pull-request counts.
 
@@ -188,9 +206,13 @@ def consolidate(rows, matches, pr_counts, repository, start, end):
     @param repository: kept for GitHub-only rows.
     @param start: start date kept for GitHub-only rows.
     @param end: end date kept for GitHub-only rows.
-    @returns: new rows with keys FIELDNAMES + GITHUB_FIELDNAMES.
+    @param identities: {author_name: emails} (STAT-13); for git_email.
+    @param github_emails: {login: public profile email or None} (STAT-13).
+    @returns: new rows with keys FIELDNAMES + GITHUB_FIELDNAMES +
+        EMAIL_FIELDNAMES.
     """
     counts = {login.casefold(): value for login, value in pr_counts.items()}
+    profile_emails = {login.casefold(): e for login, e in github_emails.items()}
 
     # group rows by login, remembering where each group first appears
     slots = []  # entries: ("row", row) or ("group", key)
@@ -213,12 +235,15 @@ def consolidate(rows, matches, pr_counts, repository, start, end):
         found = counts.get(login.casefold(), {})
         for field in _PR_FIELDS:
             out[field] = found.get(field, 0)
+        out["github_email"] = profile_emails.get(login.casefold()) or ""
         return out
 
     result = []
     for kind, item in slots:
         if kind == "row":
-            result.append(_blank_row(item))
+            out = _blank_row(item)
+            out["git_email"] = join_emails(identities.get(item["username"], ()))
+            result.append(out)
             continue
         members = groups[item]
         best = min(members, key=lambda r: (-r["commits"], r["username"]))
@@ -226,26 +251,34 @@ def consolidate(rows, matches, pr_counts, repository, start, end):
         out["username"] = best["username"]
         for field in _SUMMED_FIELDS:
             out[field] = sum(member[field] for member in members)
+        out["git_email"] = join_emails(
+            email
+            for member in members
+            for email in identities.get(member["username"], ())
+        )
         result.append(with_counts(out, spellings[item]))
 
     # STAT-11 tier 4: GitHub users that no git identity matched
     for login in sorted(pr_counts, key=str.casefold):
         if login.casefold() in groups:
             continue
-        out = {field: 0 for field in FIELDNAMES}
+        out = _blank_row({field: 0 for field in FIELDNAMES})
         out.update({"username": "", "repository": repository})
         out.update({"start_date": start, "end_date": end})
         result.append(with_counts(out, login))
     return result
 
 
-def unavailable_row(row):
+def unavailable_row(row, emails=()):
     """
-    Copy a git row with the GitHub columns marked unavailable (CLI-3).
+    Copy a git row with the GitHub columns marked unavailable (CLI-3). The
+    git_email column is still filled in (STAT-13).
     @param row: a git row.
-    @returns: a new row whose GitHub columns are all None.
+    @param emails: the author emails of the row's git identity.
+    @returns: a new row whose GitHub columns are None, except git_email.
     """
     out = {field: row[field] for field in FIELDNAMES}
-    for field in GITHUB_FIELDNAMES:
+    for field in GITHUB_FIELDNAMES + EMAIL_FIELDNAMES:
         out[field] = None
+    out["git_email"] = join_emails(emails)
     return out

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/tests/test_github.py

@@ -79,6 +79,10 @@ def test_fieldnames():
     ]
 
 
+def test_email_fieldnames():
+    assert github.EMAIL_FIELDNAMES == ["git_email", "github_email"]
+
+
 def test_check_gh_signed_in(tmp_path, monkeypatch):
     calls = install_fake_gh(tmp_path, monkeypatch)
     assert check_gh() is None

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/tests/test_identity.py

@@ -6,9 +6,10 @@ All names, emails and logins here are invented.
 import copy
 
 from gitlogstats.git_logs_parser import FIELDNAMES
-from gitlogstats.github import GITHUB_FIELDNAMES
+from gitlogstats.github import EMAIL_FIELDNAMES, GITHUB_FIELDNAMES
 from gitlogstats.identity import (
     consolidate,
+    join_emails,
     login_from_noreply,
     match_identities,
     normalize_display_name,
@@ -295,7 +296,7 @@ def test_consolidate_sums_and_picks_busiest_username():
         git_row("Zed Full", commits=7, insertions=100, deletions=20, files=9, merges=3),
     ]
     matches = {"zed": ("zhub", "email"), "Zed Full": ("ZHUB", "username")}
-    out = consolidate(rows, matches, {"zhub": pr(4, 3, 1, 2)}, "repo", "s", "e")
+    out = consolidate(rows, matches, {"zhub": pr(4, 3, 1, 2)}, "repo", "s", "e", {}, {})
     assert [r["username"] for r in out] == ["Zed Full", "Alone"]
     merged = out[0]
     assert merged["commits"] == 9
@@ -316,7 +317,7 @@ def test_consolidate_sums_and_picks_busiest_username():
 def test_consolidate_tie_broken_alphabetically():
     rows = [git_row("beta", commits=3), git_row("alpha", commits=3)]
     matches = {"beta": ("u", "email"), "alpha": ("u", "email")}
-    out = consolidate(rows, matches, {}, "repo", "s", "e")
+    out = consolidate(rows, matches, {}, "repo", "s", "e", {}, {})
     assert len(out) == 1
     assert out[0]["username"] == "alpha"
     assert out[0]["commits"] == 6
@@ -325,15 +326,15 @@ def test_consolidate_tie_broken_alphabetically():
 def test_consolidate_position_of_first_member():
     rows = [git_row("a"), git_row("b"), git_row("c"), git_row("d")]
     matches = {"a": ("one", "email"), "c": ("one", "email")}
-    out = consolidate(rows, matches, {}, "repo", "s", "e")
+    out = consolidate(rows, matches, {}, "repo", "s", "e", {}, {})
     assert [r["username"] for r in out] == ["a", "b", "d"]
     assert out[0]["commits"] == 2
 
 
 def test_consolidate_column_order_and_zero_counts():
     rows = [git_row("a")]
-    out = consolidate(rows, {"a": ("ahub", "email")}, {}, "repo", "s", "e")
-    assert list(out[0]) == FIELDNAMES + GITHUB_FIELDNAMES
+    out = consolidate(rows, {"a": ("ahub", "email")}, {}, "repo", "s", "e", {}, {})
+    assert list(out[0]) == FIELDNAMES + GITHUB_FIELDNAMES + EMAIL_FIELDNAMES
     assert out[0]["github_username"] == "ahub"
     assert out[0]["prs_opened"] == out[0]["prs_merged"] == 0
     assert out[0]["prs_self_merged"] == 0
@@ -342,7 +343,7 @@ def test_consolidate_column_order_and_zero_counts():
 def test_consolidate_github_only_rows_sorted_after_git_rows():
     rows = [git_row("a")]
     counts = {"Zed": pr(1), "ahub": pr(2, 1), "bob": pr(0, 1, 3, 1)}
-    out = consolidate(rows, {"a": ("AHUB", "email")}, counts, "repo", "S", "E")
+    out = consolidate(rows, {"a": ("AHUB", "email")}, counts, "repo", "S", "E", {}, {})
     assert [r["github_username"] for r in out] == ["AHUB", "bob", "Zed"]
     assert out[0]["prs_opened"] == 2
     only = out[1]
@@ -357,7 +358,7 @@ def test_consolidate_github_only_rows_sorted_after_git_rows():
     for field in ["commits", "insertions", "deletions", "files", "merges"]:
         assert only[field] == 0
     for r in out:
-        assert list(r) == FIELDNAMES + GITHUB_FIELDNAMES
+        assert list(r) == FIELDNAMES + GITHUB_FIELDNAMES + EMAIL_FIELDNAMES
 
 
 def test_consolidate_does_not_mutate_inputs():
@@ -365,14 +366,68 @@ def test_consolidate_does_not_mutate_inputs():
     matches = {"a": ("u", "email"), "b": ("u", "email")}
     counts = {"u": pr(1), "v": pr(2)}
     before = copy.deepcopy((rows, matches, counts))
-    consolidate(rows, matches, counts, "repo", "s", "e")
+    consolidate(rows, matches, counts, "repo", "s", "e", {}, {})
     assert (rows, matches, counts) == before
 
 
 def test_unavailable_row():
     row = git_row("a")
     out = unavailable_row(row)
-    assert list(out) == FIELDNAMES + GITHUB_FIELDNAMES
+    assert list(out) == FIELDNAMES + GITHUB_FIELDNAMES + EMAIL_FIELDNAMES
     assert all(out[f] is None for f in GITHUB_FIELDNAMES)
+    assert out["git_email"] == ""
+    assert out["github_email"] is None
     assert out["commits"] == 1
     assert "github_username" not in row
+
+
+def test_unavailable_row_keeps_git_emails():
+    out = unavailable_row(git_row("a"), {"b@x.example", "A@x.example"})
+    assert out["git_email"] == "A@x.example; b@x.example"
+    assert out["github_email"] is None
+    assert out["github_username"] is None
+
+
+# ---- emails (STAT-13) ---------------------------------------------------------
+
+
+def test_join_emails_sorts_ignoring_case_and_dedupes_ignoring_case():
+    emails = ["zed@x.example", "ada@x.example", "Ada@x.example", "", "Bob@x.example"]
+    assert join_emails(emails) == "Ada@x.example; Bob@x.example; zed@x.example"
+    assert join_emails([]) == ""
+
+
+def test_consolidate_emails_of_a_combined_row():
+    rows = [git_row("ada"), git_row("Ada L", commits=5), git_row("solo")]
+    matches = {"ada": ("ahub", "email"), "Ada L": ("AHUB", "username")}
+    identities = {
+        "ada": {"ada@x.example": "1"},
+        "Ada L": {"Ada@x.example": "2", "9+ahub@users.noreply.github.com": "3"},
+        "solo": {"solo@x.example": "4"},
+    }
+    out = consolidate(
+        rows, matches, {}, "repo", "s", "e", identities, {"ahub": "pub@x.example"}
+    )
+    assert [r["git_email"] for r in out] == [
+        "9+ahub@users.noreply.github.com; Ada@x.example",
+        "solo@x.example",
+    ]
+    assert [r["github_email"] for r in out] == ["pub@x.example", ""]
+
+
+def test_consolidate_github_only_row_has_no_git_email():
+    out = consolidate(
+        [],
+        {},
+        {"Zed": pr(1), "bob": pr(1)},
+        "repo",
+        "s",
+        "e",
+        {},
+        {"zed": "zed@x.example", "bob": None},
+    )
+    assert [(r["github_username"], r["git_email"], r["github_email"]) for r in out] == [
+        ("bob", "", ""),
+        ("Zed", "", "zed@x.example"),
+    ]
+    assert list(out[0]) == FIELDNAMES + GITHUB_FIELDNAMES + EMAIL_FIELDNAMES

{gitlogstats-1.2.0 → gitlogstats-1.3.0}/tests/test_integration.py

@@ -3,7 +3,9 @@ Integration tests: build real git repositories and check the statistics that
 GitLogsParser and the gitlogstats command derive from them.
 """
 
+import csv
 import datetime
+import io
 import json
 import os
 import shutil
@@ -973,6 +975,7 @@ GITHUB_COLUMNS = [
     "prs_self_merged",
 ]
 PR_COLUMNS = GITHUB_COLUMNS[1:]
+EMAIL_COLUMNS = ["git_email", "github_email"]
 NOT_INSTALLED = (
     "gitlogstats: --github needs the GitHub CLI (gh), which is not installed. "
     "Install it from https://cli.github.com and run 'gh auth login', "
@@ -1386,11 +1389,15 @@ class TestGitHub:
         self, team, tmp_path, monkeypatch, capsys
     ):
         out, _ = self.github(monkeypatch, capsys, tmp_path, "-u", "alice-gh")
-        assert out.splitlines()[1].endswith(",alice-gh,3,1,1,1")
+        assert out.splitlines()[1].endswith(
+            ",alice-gh,3,1,1,1,alice@example.com; asmith@example.com,"
+        )
         out, _ = self.github(
             monkeypatch, capsys, tmp_path, "-u", "alice-gh", "-f", "markdown"
         )
-        assert out.splitlines()[2].endswith("| alice-gh | 3 | 1 | 1 | 1 |")
+        assert out.splitlines()[2].endswith(
+            "| alice-gh | 3 | 1 | 1 | 1 | alice@example.com; asmith@example.com |  |"
+        )
 
     @pytest.mark.parametrize(
         "user",
@@ -1441,17 +1448,17 @@ class TestGitHub:
         out, _ = self.github(monkeypatch, capsys, tmp_path, "-u", "Bob")
         assert out == (
             "username,repository,start_date,end_date,commits,insertions,deletions,"
-            "files,merges,github_username,prs_opened,prs_merged,prs_closed_unmerged,prs_self_merged\n"
-            "Bob,widgets,01/01/2024,12/31/2024,1,2,0,1,0,bobby,0,1,0,0\n"
+            "files,merges,github_username,prs_opened,prs_merged,prs_closed_unmerged,prs_self_merged,git_email,github_email\n"
+            "Bob,widgets,01/01/2024,12/31/2024,1,2,0,1,0,bobby,0,1,0,0,bob@example.com,\n"
         )
         out, _ = self.github(
             monkeypatch, capsys, tmp_path, "-u", "Bob", "-f", "markdown"
         )
         header, _, row = out.splitlines()
         assert header.endswith(
-            "| merges | github_username | prs_opened | prs_merged | prs_closed_unmerged | prs_self_merged |"
+            "| merges | github_username | prs_opened | prs_merged | prs_closed_unmerged | prs_self_merged | git_email | github_email |"
         )
-        assert row.endswith("| 0 | bobby | 0 | 1 | 0 | 0 |")
+        assert row.endswith("| 0 | bobby | 0 | 1 | 0 | 0 | bob@example.com |  |")
 
     def test_empty_csv_still_has_the_github_columns(
         self, team, tmp_path, monkeypatch, capsys
@@ -1459,7 +1466,198 @@ class TestGitHub:
         out, _ = self.github(monkeypatch, capsys, tmp_path, "-u", "nobody")
         assert out == (
             "username,repository,start_date,end_date,commits,insertions,deletions,"
-            "files,merges,github_username,prs_opened,prs_merged,prs_closed_unmerged,prs_self_merged\n"
+            "files,merges,github_username,prs_opened,prs_merged,prs_closed_unmerged,prs_self_merged,git_email,github_email\n"
+        )
+
+    # --- email columns (STAT-13)
+
+    def emails_of(self, out):
+        """JSON rows as (username, github_username, git_email, github_email)."""
+        return [
+            (r["username"], r["github_username"], r["git_email"], r["github_email"])
+            for r in json.loads(out)
+        ]
+
+    @pytest.fixture
+    def ada(self, widgets, tmp_path, monkeypatch):
+        """Ada: two git names and three addresses, one only differing in case."""
+        # the old commit goes first: git stops reading at a too-old commit
+        widgets.write("e.txt", lines(1))
+        widgets.commit(
+            "ada", "old", date="2020-01-01 12:00:00", email="a.old@x.example"
+        )
+        widgets.write("a.txt", lines(1))
+        widgets.commit("ada", "base", email="Ada@x.example")
+        first = head(widgets)
+        widgets.write("b.txt", lines(2))
+        widgets.commit("ada", "again", email="ada@x.example")
+        widgets.write("c.txt", lines(3))
+        widgets.commit(
+            "Ada Lovelace", "web", email="111+adal99@users.noreply.github.com"
+        )
+        third = head(widgets)
+        widgets.write("d.txt", lines(1))
+        widgets.commit("Zoe", "other", email="zoe@x.example")
+        return widgets, {first: "adal99", third: "adal99"}
+
+    def ada_world(self, ada, tmp_path, monkeypatch, users, extra_prs=()):
+        widgets, linked = ada
+        github_world(
+            tmp_path,
+            monkeypatch,
+            widgets,
+            prs=[pr("adal99", at(2024, 3, 5)), *extra_prs],
+            users=users,
+            contributors=["adal99"],
+            linked=linked,
+        )
+
+    def test_combined_row_lists_every_git_email_sorted_and_deduplicated(
+        self, ada, tmp_path, monkeypatch, capsys
+    ):
+        self.ada_world(ada, tmp_path, monkeypatch, {"adal99": {"name": None}})
+        out, _ = self.github(monkeypatch, capsys, tmp_path, "-f", "json")
+        rows = self.emails_of(out)
+        # case-insensitive order and one of the two case variants; the 2020
+        # address is outside the date range; the noreply address is included
+        assert rows[0] == (
+            "ada",
+            "adal99",
+            "111+adal99@users.noreply.github.com; a.old@x.example; Ada@x.example",
+            "",
+        )
+        # an unmatched git row has no GitHub email
+        assert rows[1] == ("Zoe", "", "zoe@x.example", "")
+
+    def test_public_profile_email_is_github_email(
+        self, ada, tmp_path, monkeypatch, capsys
+    ):
+        self.ada_world(
+            ada,
+            tmp_path,
+            monkeypatch,
+            {"adal99": {"name": None, "email": "ada@pub.example"}},
+        )
+        out, _ = self.github(monkeypatch, capsys, tmp_path, "-f", "json")
+        assert self.emails_of(out)[0][3] == "ada@pub.example"
+
+    def test_github_only_row_has_empty_git_email(
+        self, ada, tmp_path, monkeypatch, capsys
+    ):
+        self.ada_world(
+            ada,
+            tmp_path,
+            monkeypatch,
+            {
+                "adal99": {"name": None},
+                "pro": {"name": None, "email": "pro@pub.example"},
+            },
+            extra_prs=[pr("pro", at(2024, 3, 8))],
+        )
+        out, _ = self.github(monkeypatch, capsys, tmp_path, "-f", "json")
+        assert self.emails_of(out)[-1] == ("", "pro", "", "pro@pub.example")
+
+    def test_matched_login_that_was_not_a_candidate_gets_its_profile(
+        self, widgets, tmp_path, monkeypatch, capsys
+    ):
+        # GitHub links the address to "ghost-writer", who has no pull request
+        # and is not a listed contributor, so the profile is fetched afterwards
+        widgets.write("a.txt", lines(1))
+        widgets.commit("Quinn", "work", email="q@x.example")
+        github_world(
+            tmp_path,
+            monkeypatch,
+            widgets,
+            prs=[],
+            users={"ghost-writer": {"name": None, "email": "gw@pub.example"}},
+            linked={head(widgets): "ghost-writer"},
+        )
+        out, _ = self.github(monkeypatch, capsys, tmp_path, "-f", "json")
+        assert self.emails_of(out) == [
+            ("Quinn", "ghost-writer", "q@x.example", "gw@pub.example")
+        ]
+
+    def test_missing_profile_of_matched_login_leaves_github_email_empty(
+        self, widgets, tmp_path, monkeypatch, capsys
+    ):
+        widgets.write("a.txt", lines(1))
+        widgets.commit("Quinn", "work", email="q@x.example")
+        github_world(
+            tmp_path,
+            monkeypatch,
+            widgets,
+            linked={head(widgets): "ghost-writer"},
+            extra_routes={
+                "users/ghost-writer": {"error": "gh: Not Found (HTTP 404)\n"}
+            },
+        )
+        out, err = self.github(monkeypatch, capsys, tmp_path, "-f", "json")
+        assert self.emails_of(out) == [("Quinn", "ghost-writer", "q@x.example", "")]
+        assert err == ""
+
+    def test_profile_error_of_matched_login_makes_repository_unavailable(
+        self, widgets, tmp_path, monkeypatch, capsys
+    ):
+        widgets.write("a.txt", lines(1))
+        widgets.commit("Quinn", "work", email="q@x.example")
+        github_world(
+            tmp_path,
+            monkeypatch,
+            widgets,
+            linked={head(widgets): "ghost-writer"},
+            extra_routes={
+                "users/ghost-writer": {"error": "gh: rate limit exceeded (HTTP 403)\n"}
+            },
+        )
+        out, err = self.github(monkeypatch, capsys, tmp_path, "-f", "json")
+        assert self.emails_of(out) == [("Quinn", None, "q@x.example", None)]
+        assert "rate limit" in err
+
+    def test_csv_round_trips_the_joined_emails(
+        self, ada, tmp_path, monkeypatch, capsys
+    ):
+        self.ada_world(
+            ada,
+            tmp_path,
+            monkeypatch,
+            {"adal99": {"name": None, "email": "ada@pub.example"}},
+        )
+        out, _ = self.github(monkeypatch, capsys, tmp_path)
+        table = list(csv.DictReader(io.StringIO(out)))
+        assert list(table[0])[-7:] == GITHUB_COLUMNS + EMAIL_COLUMNS
+        assert table[0]["git_email"].split("; ") == [
+            "111+adal99@users.noreply.github.com",
+            "a.old@x.example",
+            "Ada@x.example",
+        ]
+        assert table[0]["github_email"] == "ada@pub.example"
+        assert (table[1]["git_email"], table[1]["github_email"]) == (
+            "zoe@x.example",
+            "",
+        )
+
+    def test_emails_do_not_count_as_activity_for_clean(
+        self, widgets, tmp_path, monkeypatch, capsys
+    ):
+        widgets.write("a.txt", lines(1))
+        widgets.commit("Old", "work", date="2020-01-01 12:00:00", email="old@x.example")
+        github_world(tmp_path, monkeypatch, widgets)
+        out, _ = self.github(monkeypatch, capsys, tmp_path, "-f", "json")
+        assert self.emails_of(out) == [("Old", "", "old@x.example", "")]
+        out, _ = self.github(monkeypatch, capsys, tmp_path, "-f", "json", "-c")
+        assert out == "[]\n"
+
+    def test_without_github_there_are_no_email_columns(
+        self, widgets, tmp_path, monkeypatch, capsys
+    ):
+        widgets.write("a.txt", lines(1))
+        widgets.commit("Alice", "work", email="alice@example.com")
+        github_world(tmp_path, monkeypatch, widgets)
+        out, _ = run_github(monkeypatch, capsys, tmp_path, "-r", GITHUB_URL, *DATES)
+        assert out == (
+            "username,repository,start_date,end_date,commits,insertions,deletions,"
+            "files,merges\n"
+            "Alice,widgets,01/01/2024,12/31/2024,1,1,0,1,0\n"
         )
 
     # --- repositories GitHub cannot be asked about
@@ -1482,10 +1680,13 @@ class TestGitHub:
         assert [c for c in calls() if c[0] == "api"] == []
         out, _ = run_github(monkeypatch, capsys, tmp_path, *argv)
         assert (
-            out.splitlines()[1] == "Alice,widgets,01/01/2024,12/31/2024,1,3,0,1,0,,,,,"
+            out.splitlines()[1]
+            == "Alice,widgets,01/01/2024,12/31/2024,1,3,0,1,0,,,,,,alice@example.com,"
         )
         out, _ = run_github(monkeypatch, capsys, tmp_path, *argv, "-f", "markdown")
-        assert out.splitlines()[2].endswith("| 0 |  |  |  |  |  |")
+        assert out.splitlines()[2].endswith(
+            "| 0 |  |  |  |  |  | alice@example.com |  |"
+        )
 
     def test_github_failure_for_one_repository_does_not_stop_the_next(
         self, widgets, tmp_path, monkeypatch, capsys
@@ -1516,6 +1717,11 @@ class TestGitHub:
             ("Bob", "other", 1),
         ]
         assert all(r[c] is None for r in data for c in GITHUB_COLUMNS)
+        # STAT-13: git_email is still filled in, github_email is unavailable
+        assert [(r["git_email"], r["github_email"]) for r in data] == [
+            ("alice@example.com", None),
+            ("bob@example.com", None),
+        ]
 
     def test_clean_and_user_apply_to_unavailable_rows_too(
         self, widgets, tmp_path, monkeypatch, capsys