Merge pull request #84 from timvink/67-more-robust-count-commits

Simplify count_commits() and add unit tests, closes #67

Author: timvink

mkdocs_git_revision_date_localized_plugin/ci.py

@@ -20,6 +20,7 @@ def raise_ci_warnings(repo) -> None:
 
     n_commits = commit_count(repo)
 
+
     # Gitlab Runners
     if os.getenv("GITLAB_CI") is not None and n_commits < 50:
         # Default is GIT_DEPTH of 50 for gitlab
@@ -85,11 +86,7 @@ def commit_count(repo) -> int:
     Returns:
         count (int): Number of commits.
     """
-    refs = repo.for_each_ref().split("\n")
-    refs = [x.split()[0] for x in refs]
-
-    counts = [int(repo.rev_list(x, count=True, first_parent=True)) for x in refs]
-    return max(counts)
+    return int(repo.rev_list('--count','HEAD'))
 
 
 def is_shallow_clone(repo) -> bool:

tests/test_builds.py

@@ -28,6 +28,7 @@
 
 # package module
 from mkdocs_git_revision_date_localized_plugin.util import Util
+from mkdocs_git_revision_date_localized_plugin.ci import commit_count
 
 # ##################################
 # ######## Globals #################
@@ -350,7 +351,13 @@ def test_tags_are_replaced(tmp_path, mkdocs_file):
 
     if plugin_config.get("type") == "timeago":
        pytest.skip("Not necessary to test the JS library")
-    
+
+    # Make sure count_commits() works
+    # We created 8 commits in setup_commit_history()
+    with working_directory(testproject_path):
+        u = Util()
+        assert commit_count(u._get_repo("docs/page_with_tag.md")) == 8
+
 
     # the revision date was in 'setup_commit_history' was set to 1642911026 (Sun Jan 23 2022 04:10:26 GMT+0000)
     # Assert {{ git_revision_date_localized }} is replaced