Fix bug with raw page.meta creation tags, see #64

Author: timvink

mkdocs_git_revision_date_localized_plugin/plugin.py

@@ -155,13 +155,14 @@ def on_page_markdown(
             logging.debug("Excluding page " + page.file.src_path)
             return markdown
 
-        # revision date
-        revision_dates = self.util.get_date_formats_for_timestamp(
-            commit_timestamp=self.util.get_git_commit_timestamp(
+        # Retrieve git commit timestamp
+        last_revision_timestamp = self.util.get_git_commit_timestamp(
                 path=page.file.abs_src_path,
                 is_first_commit=False,
-            )
         )
+
+        # Last revision date
+        revision_dates = self.util.get_date_formats_for_timestamp(last_revision_timestamp)
         revision_date = revision_dates[self.config["type"]]
 
         # timeago output is dynamic, which breaks when you print a page
@@ -170,8 +171,13 @@ def on_page_markdown(
         if self.config["type"] == "timeago":
             revision_date += revision_dates["iso_date"]
 
-        # Add to page meta information
+        # Add to page meta information, for developers
+        # Include variants without the CSS <span> elements (raw date strings)
         page.meta["git_revision_date_localized"] = revision_date
+        revision_dates_raw = self.util.get_date_formats_for_timestamp(last_revision_timestamp, add_spans=False)
+        for date_type, date_string in revision_dates_raw.items():
+            page.meta["git_revision_date_localized_raw_%s" % date_type] = date_string
+
         # Replace any occurances in markdown page
         markdown = re.sub(
             r"\{\{\s*git_revision_date_localized\s*\}\}",
@@ -180,54 +186,41 @@ def on_page_markdown(
             flags=re.IGNORECASE,
         )
 
-        # Creation date
-        if self.config.get("enable_creation_date"):
-            creation_dates = self.util.get_date_formats_for_timestamp(
-                commit_timestamp=self.util.get_git_commit_timestamp(
-                    path=page.file.abs_src_path,
-                    is_first_commit=True,
-                )
-            )
-            creation_date = creation_dates[self.config["type"]]
-
-            # timeago output is dynamic, which breaks when you print a page
-            # This ensures fallback to type "iso_date"
-            # controlled via CSS (see on_post_build() event)
-            if self.config["type"] == "timeago":
-                creation_date += creation_dates["iso_date"]
-
-            page.meta["git_creation_date_localized"] = creation_date
-            markdown = re.sub(
-                r"\{\{\s*git_creation_date_localized\s*\}\}",
-                creation_date,
-                markdown,
-                flags=re.IGNORECASE,
-            )
-
-        # Developers might want access to the raw date strings
-        # Let's expose them also
-        revision_dates = self.util._date_formats(
-            unix_timestamp=self.util.get_git_commit_timestamp(
-                path=page.file.abs_src_path,
-                is_first_commit=False,
-            ),
-            time_zone=self.config.get("time_zone"),
-            locale=self.config.get("locale")
+        # If creation date not enabled, return markdown
+        # This is for speed: prevents another `git log` operation each file
+        if not self.config.get("enable_creation_date"):
+            return markdown
+    
+        # Retrieve git commit timestamp
+        first_revision_timestamp = self.util.get_git_commit_timestamp(
+            path=page.file.abs_src_path,
+            is_first_commit=True,
         )
-        for date_type, date_string in revision_dates.items():
-            page.meta["git_revision_date_localized_raw_%s" % date_type] = date_string
 
-        if self.config.get("enable_creation_date"):
-            creation_dates = self.util._date_formats(
-                unix_timestamp=self.util.get_git_commit_timestamp(
-                    path=page.file.abs_src_path,
-                    is_first_commit=False,
-                ),
-                time_zone=self.config.get("time_zone"),
-                locale=self.config.get("locale")
-            )
-            for date_type, date_string in creation_dates.items():
-                page.meta["git_creation_date_localized_raw_%s" % date_type] = date_string
+        # Creation date formats
+        creation_dates = self.util.get_date_formats_for_timestamp(first_revision_timestamp)
+        creation_date = creation_dates[self.config["type"]]
+
+        # timeago output is dynamic, which breaks when you print a page
+        # This ensures fallback to type "iso_date"
+        # controlled via CSS (see on_post_build() event)
+        if self.config["type"] == "timeago":
+            creation_date += creation_dates["iso_date"]
+
+        # Add to page meta information, for developers
+        # Include variants without the CSS <span> elements (raw date strings)
+        page.meta["git_creation_date_localized"] = creation_date
+        creation_dates_raw = self.util.get_date_formats_for_timestamp(first_revision_timestamp, add_spans=False)
+        for date_type, date_string in creation_dates_raw.items():
+            page.meta["git_creation_date_localized_raw_%s" % date_type] = date_string
+
+        # Replace any occurances in markdown page
+        markdown = re.sub(
+            r"\{\{\s*git_creation_date_localized\s*\}\}",
+            creation_date,
+            markdown,
+            flags=re.IGNORECASE,
+        )
 
         return markdown
 

mkdocs_git_revision_date_localized_plugin/util.py

@@ -2,7 +2,7 @@
 import logging
 import os
 import time
-from datetime import datetime
+from datetime import date, datetime
 
 from mkdocs_git_revision_date_localized_plugin.ci import raise_ci_warnings
 
@@ -173,9 +173,10 @@ def get_git_commit_timestamp(
     def get_date_formats_for_timestamp(
         self,
         commit_timestamp: int,
+        add_spans: bool = True
     ) -> Dict[str, str]:
         """
-        Determine localized date variants for a given file.
+        Determine localized date variants for a given timestamp.
 
         Args:
             commit_timestamp (int): most recent commit date in unix timestamp.
@@ -185,19 +186,25 @@ def get_date_formats_for_timestamp(
         Returns:
             dict: Localized date variants.
         """
-
         date_formats = self._date_formats(
             unix_timestamp=commit_timestamp, 
             time_zone=self.config.get("time_zone"),
             locale=self.config.get("locale")
         )
+        if add_spans:
+            date_formats = self.add_spans(date_formats)
+
+        return date_formats
 
-        # Wrap in <span> for styling
+
+    @staticmethod
+    def add_spans(date_formats: Dict[str, str]) -> Dict[str, str]:
+        """
+        Wraps the date string in <span> elements with CSS identifiers.
+        """
         for date_type, date_string in date_formats.items():
             date_formats[date_type] = (
                 '<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-%s">%s</span>'
                 % (date_type, date_string)
             )
-
         return date_formats
-

setup.py

@@ -12,7 +12,7 @@
 
 setup(
     name="mkdocs-git-revision-date-localized-plugin",
-    version="0.10.1",
+    version="0.10.2",
     description="Mkdocs plugin that enables displaying the localized date of the last git modification of a markdown file.",
     long_description=LONG_DESCRIPTION,
     long_description_content_type="text/markdown",