fix windows issue

Author: timvink

docs/options.md

@@ -159,9 +159,9 @@ Default is `true`. When enabled, the logs will show warnings when something is w
 
 ## `ignored_commits_file`
 
-Default is `None`. When specified, contains a file that contains a list of commit hashes to ignore
-when determining the most recent updated time. The format of the file is the same as the format of
-git `blame.ignoreRevsFile`. This can be useful to ignore formatting updates or other mass changes to the documents.
+Default is `None`. You can specify a file path (relative to your `mkdocs.yml` directory) that contains a list of commit hashes to ignore
+when determining the revision date. The format of the file is the same as the format of
+git `blame.ignoreRevsFile`. This can be useful to ignore specific commits that apply formatting updates or other mass changes to the documents.
 
 
 === ":octicons-file-code-16: mkdocs.yml"

src/mkdocs_git_revision_date_localized_plugin/plugin.py

@@ -67,7 +67,7 @@ def on_config(self, config: config_options.Config, **kwargs) -> Dict[str, Any]:
 
         assert self.config['type'] in ["date","datetime","iso_date","iso_datetime","timeago","custom"]
 
-        self.util = Util(config=self.config)
+        self.util = Util(config=self.config, mkdocs_dir=os.path.abspath(os.path.dirname(config.get('config_file_path'))))
 
         # Save last commit timestamp for entire site
         self.last_site_revision_timestamp = self.util.get_git_commit_timestamp(

src/mkdocs_git_revision_date_localized_plugin/util.py

@@ -27,13 +27,14 @@ class Util:
     This helps find git and calculate relevant dates.
     """
 
-    def __init__(self, config={}):
+    def __init__(self, config: Dict, mkdocs_dir: str):
         """Initialize utility class."""
         self.config = config
         self.repo_cache = {}
 
         ignore_commits_file = self.config.get("ignored_commits_file")
-        self.ignored_commits = self.parse_git_ignore_revs(ignore_commits_file) if ignore_commits_file else []
+        ignore_commits_filepath = os.path.join(mkdocs_dir, ignore_commits_file) if ignore_commits_file else None
+        self.ignored_commits = self.parse_git_ignore_revs(ignore_commits_filepath) if ignore_commits_file else []
 
     def _get_repo(self, path: str) -> Git:
         if not os.path.isdir(path):
@@ -66,6 +67,7 @@ def get_git_commit_timestamp(
             int: commit date in unix timestamp, starts with the most recent commit.
         """
         commit_timestamp = ""
+        n_ignored_commits = 0
 
         # Determine the logging level
         # Only log warnings when plugin is set to strict.
@@ -111,14 +113,17 @@ def get_git_commit_timestamp(
                 ).split("\n")
 
                 # process the commits for the file in reverse-chronological order. Ignore any commit that is on the
-                # ignored list. If the line is empty, we've reached the end and need to use the fallback behavior
+                # ignored list. If the line is empty, we've reached the end and need to use the fallback behavior.
                 for line in lines:
                     if not line:
                         commit_timestamp = ""
                         break
                     commit, commit_timestamp = line.split(" ")
                     if not any(commit.startswith(x) for x in self.ignored_commits):
                         break
+                    else:
+                        n_ignored_commits += 1
+
 
         except (InvalidGitRepositoryError, NoSuchPathError) as err:
             if self.config.get('fallback_to_build_date'):
@@ -165,10 +170,13 @@ def get_git_commit_timestamp(
         # create timestamp
         if commit_timestamp == "":
             commit_timestamp = time.time()
-            log(
+            msg = (
                 "[git-revision-date-localized-plugin] '%s' has no git logs, using current timestamp"
                 % path
             )
+            if n_ignored_commits:
+                msg += f" (ignored {n_ignored_commits} commits)"
+            log(msg)
 
         return int(commit_timestamp)
 
@@ -222,10 +230,17 @@ def parse_git_ignore_revs(filename: str) -> List[str]:
         Whitespace, blanklines and comments starting with # are all ignored.
         """
         result = []
-        with open(filename, "rt") as f:
-            for line in f:
-                line = line.split("#", 1)[0].strip()
-                if not line:
-                    continue
-                result.append(line)
+        
+        try:
+            with open(filename, "rt", encoding='utf-8') as f:
+                for line in f:
+                    line = line.split("#", 1)[0].strip()
+                    if not line:
+                        continue
+                    result.append(line)
+        except FileNotFoundError:
+            logger.error(f"File not found: {filename}")
+        except Exception as e:
+            logger.error(f"An error occurred while reading the file {filename}: {e}")
+        
         return result

tests/fixtures/basic_project/.gitignore

@@ -0,0 +1 @@
+site/

tests/test_builds.py

@@ -254,7 +254,7 @@ def validate_build(testproject_path, plugin_config: dict = {}):
     contents = page_with_tag.read_text(encoding="utf8")
     assert re.search(r"renders as\:\s[<span>|\w].+", contents)
 
-    repo = Util(config=plugin_config)
+    repo = Util(config=plugin_config, mkdocs_dir=testproject_path)
     date_formats = repo.get_date_formats_for_timestamp(
         commit_timestamp=repo.get_git_commit_timestamp(
             path=str(testproject_path / "docs/page_with_tag.md"),
@@ -380,7 +380,7 @@ def test_tags_are_replaced(tmp_path, mkdocs_file):
     # Make sure count_commits() works
     # We created 11 commits in setup_commit_history()
     with working_directory(testproject_path):
-        u = Util()
+        u = Util(config={}, mkdocs_dir=os.getcwd())
         assert commit_count(u._get_repo("docs/page_with_tag.md")) == 11
 
 
@@ -682,7 +682,7 @@ def test_ignored_commits(tmp_path):
 
     # First test that the middle commit doesn't show up by default
     # January 23, 2022 is the date of the most recent commit
-    with open(str(testproject_path / "ignored-commits.txt"), "wt") as fp:
+    with open(str(testproject_path / "ignored-commits.txt"), "wt", encoding="utf-8") as fp:
         fp.write("")
 
     result = build_docs_setup(testproject_path)
@@ -694,10 +694,10 @@ def test_ignored_commits(tmp_path):
 
     # Now mark the most recent change to page_with_tag as ignored
     # May 4, 2018 is the date of the second most recent commit
-    hash = repo.git.log("docs/page_with_tag.md", format="%H", n=1)
+    commit_hash = repo.git.log("docs/page_with_tag.md", format="%H", n=1)
 
-    with open(str(testproject_path / "ignored-commits.txt"), "wt") as fp:
-        fp.write(hash)
+    with open(str(testproject_path / "ignored-commits.txt"), "wt", encoding="utf-8") as fp:
+        fp.write(commit_hash)
 
     # should not raise warning
     result = build_docs_setup(testproject_path)