Issue #90 | Sort page authors by page contribution, not site contribution

TimiMakkonen · timvink · commit 9277f8c3eba5 · 2025-04-22T12:24:48.000+02:00
* fixes #90
diff --git a/src/mkdocs_git_authors_plugin/git/page.py b/src/mkdocs_git_authors_plugin/git/page.py
@@ -1,7 +1,7 @@
 import logging
 import re
 from pathlib import Path
-from typing import List
+from typing import Any, List
 
 from mkdocs_git_authors_plugin.git.command import GitCommand, GitCommandError
 from mkdocs_git_authors_plugin.git.repo import AbstractRepoObject, Repo
@@ -73,7 +73,7 @@ def get_authors(self) -> List[dict]:
                 or repo.config("show_contribution")
                 or repo.config("sort_authors_by") == "contribution"
             )
-            self._authors = sorted(self._authors, key=repo._sort_key, reverse=reverse)
+            self._authors = sorted(self._authors, key=self._sort_key, reverse=reverse)
             self._sorted = True
             author_threshold = repo.config("authorship_threshold_percent")
             if author_threshold > 0 and len(self._authors) > 1:
@@ -210,6 +210,26 @@ def path(self) -> Path:
         """
         return self._path
 
+    def _sort_key(self, author) -> Any:
+        """
+        Return a sort key for an author.
+
+        Args:
+            author: an Author object
+
+        Returns:
+            comparison key for the sorted() function,
+        """
+        repo = self.repo()
+        if (
+            repo.config("show_line_count")
+            or repo.config("show_contribution")
+            or repo.config("sort_authors_by") == "contribution"
+        ):
+            return getattr(author, "contribution")(self.path())
+        else:
+            return getattr(author, "name")()
+
     def total_lines(self) -> int:
         """
         Total number of lines in the markdown source file.
diff --git a/tests/test_util.py b/tests/test_util.py
@@ -31,12 +31,19 @@
     "show_contribution": False,
     "show_line_count": False,
     "show_email_address": True,
+    "href": "mailto:{email}",
     "count_empty_lines": True,
-    "sort_authors_by_name": True,
-    "sort_reverse": False,
+    "fallback_to_empty": False,
+    "exclude": [],
+    "ignore_commits": "",
+    "ignore_authors": [],
+    "enabled": True,
+    "enabled_on_serve": True,
     "sort_authors_by": "name",
     "authorship_threshold_percent": 0,
-    "ignore_authors": [],
+    "strict": True,
+    #"sort_authors_by_name": True,
+    #"sort_reverse": False,
 }
 
 #### Helpers ####
@@ -129,6 +136,16 @@ def setup_commit_history(testproject_path):
     return repo
 
 
+def commit_lines(r, file_name, author_name, author_email, num_of_lines=1):
+    with open(file_name, "a") as the_file:
+        for i in range(num_of_lines):
+            the_file.write("Hello\n")
+    
+    r.index.add([file_name])
+    author = gitpython.Actor(author_name, author_email)
+    r.index.commit("some commit", author=author)
+
+
 #### Tests ####
 
 
@@ -477,6 +494,186 @@ def test_mkdocs_in_git_subdir(tmp_path):
     os.chdir(cwd)
 
 
+def test_page_authors_summary(tmp_path):
+    """
+    Builds a fake git project with some commits.
+
+    Args:
+        tmp_path (PosixPath): Directory of a tempdir
+    """
+    cwd = os.getcwd()
+    os.chdir(str(tmp_path))
+
+    config = DEFAULT_CONFIG.copy()
+
+    # Create a git repo and file
+    r = gitpython.Repo.init(tmp_path)
+    file_name = str(tmp_path / "new-file")
+
+    # Initial commit
+    commit_lines(r, file_name, "Tim", "abc@abc.com")
+    
+    repo_instance = repo.Repo()
+    repo_instance.set_config(config)
+    page_instance = repo_instance.page(file_name)
+
+    authors_summary = util.page_authors_summary(page_instance, config)
+
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:abc@abc.com'>Tim</a>"\
+                            "</span>"
+
+
+    # Now add a line to the file
+    # From a second author with same email
+    commit_lines(r, file_name, "Tim2", "abc@abc.com")
+
+    repo_instance = repo.Repo()
+    repo_instance.set_config(config)
+    page_instance = repo_instance.page(file_name)
+
+    authors_summary = util.page_authors_summary(page_instance, config)
+
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:abc@abc.com'>Tim</a>"\
+                            "</span>"
+
+
+    # Then a third commit from a new author
+    commit_lines(r, file_name, "John", "john@abc.com")
+
+    repo_instance = repo.Repo()
+    repo_instance.set_config(config)
+    page_instance = repo_instance.page(file_name)
+
+    authors_summary = util.page_authors_summary(page_instance, config)
+
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:john@abc.com'>John</a>, "\
+                            "<a href='mailto:abc@abc.com'>Tim</a>"\
+                            "</span>"
+
+    os.chdir(cwd)
+
+
+def test_page_authors_summary_showing_contribution(tmp_path):
+    """
+    Builds a fake git project with some commits.
+
+    Args:
+        tmp_path (PosixPath): Directory of a tempdir
+    """
+    cwd = os.getcwd()
+    os.chdir(str(tmp_path))
+
+    config = DEFAULT_CONFIG.copy()
+    config["show_contribution"] = True
+
+    # Create a git repo and file
+    r = gitpython.Repo.init(tmp_path)
+    file_name = str(tmp_path / "new-file")
+
+    # Initial commit
+    commit_lines(r, file_name, "Tim", "abc@abc.com")
+    
+    repo_instance = repo.Repo()
+    repo_instance.set_config(config)
+    page_instance = repo_instance.page(file_name)
+
+    authors_summary = util.page_authors_summary(page_instance, config)
+
+    # Contribution is not shown if there is only single Author
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:abc@abc.com'>Tim</a>"\
+                            "</span>"
+
+
+    # Now add a line to the file
+    # From a second author with same email
+    commit_lines(r, file_name, "Tim2", "abc@abc.com")
+
+    repo_instance = repo.Repo()
+    repo_instance.set_config(config)
+    page_instance = repo_instance.page(file_name)
+
+    authors_summary = util.page_authors_summary(page_instance, config)
+
+    # Contribution is not shown if there is only single Author
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:abc@abc.com'>Tim</a>"\
+                            "</span>"
+
+
+    # Then a third commit from a new author
+    commit_lines(r, file_name, "John", "john@abc.com")
+
+    repo_instance = repo.Repo()
+    repo_instance.set_config(config)
+    page_instance = repo_instance.page(file_name)
+
+    authors_summary = util.page_authors_summary(page_instance, config)
+
+    # Contribution is shown if there are multiple authors, ordered by contribution
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:abc@abc.com'>Tim</a> (66.67%), "\
+                            "<a href='mailto:john@abc.com'>John</a> (33.33%)"\
+                            "</span>"
+
+    os.chdir(cwd)
+
+
+def test_page_authors_summary_showing_contribution_ordering_by_page_contribution(tmp_path):
+    """
+    Builds a fake git project with some commits.
+
+    Args:
+        tmp_path (PosixPath): Directory of a tempdir
+    """
+    cwd = os.getcwd()
+    os.chdir(str(tmp_path))
+
+    config = DEFAULT_CONFIG.copy()
+    config["show_contribution"] = True
+
+    # Create a git repo and files
+    r = gitpython.Repo.init(tmp_path)
+    file_name = str(tmp_path / "new-file")
+    file_name2 = str(tmp_path / "new-file2")
+
+    # Commits by multiple authors on multiple files
+    commit_lines(r, file_name, "Tim", "tim@abc.com", 8)
+    commit_lines(r, file_name, "John", "john@abc.com", 4)
+    commit_lines(r, file_name, "Thomas", "thomas@abc.com", 2)
+
+    commit_lines(r, file_name2, "Tim", "tim@abc.com", 4)
+    commit_lines(r, file_name2, "John", "john@abc.com", 16)
+    commit_lines(r, file_name2, "Thomas", "thomas@abc.com", 8)
+    
+    repo_instance = repo.Repo()
+    repo_instance.set_config(config)
+    page_instance = repo_instance.page(file_name)
+    page_instance2 = repo_instance.page(file_name2)
+
+    authors_summary = util.page_authors_summary(page_instance, config)
+
+    # Contribution is shown if there are multiple authors, ordered by contribution on page
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:tim@abc.com'>Tim</a> (57.14%), "\
+                            "<a href='mailto:john@abc.com'>John</a> (28.57%), "\
+                            "<a href='mailto:thomas@abc.com'>Thomas</a> (14.29%)"\
+                            "</span>"
+    
+    authors_summary = util.page_authors_summary(page_instance2, config)
+
+    assert authors_summary == "<span class='git-page-authors git-authors'>"\
+                            "<a href='mailto:john@abc.com'>John</a> (57.14%), "\
+                            "<a href='mailto:thomas@abc.com'>Thomas</a> (28.57%), "\
+                            "<a href='mailto:tim@abc.com'>Tim</a> (14.29%)"\
+                            "</span>"
+
+    os.chdir(cwd)
+
+
 def test_summarize_authors():
     """
     Test summary functions.
