Refactor code

timvink · timvink · commit 27b4d4a3eb54 · 2021-04-12T15:22:31.000+02:00
diff --git a/mkdocs_git_revision_date_localized_plugin/css/timeago.css b/mkdocs_git_revision_date_localized_plugin/css/timeago.css
@@ -9,3 +9,4 @@
     .git-revision-date-localized-plugin-iso_date { display: inline } 
     .git-revision-date-localized-plugin-timeago { display: none } 
 }
+
diff --git a/mkdocs_git_revision_date_localized_plugin/plugin.py b/mkdocs_git_revision_date_localized_plugin/plugin.py
@@ -149,14 +149,11 @@ def on_page_markdown(
             return markdown
 
         # revision date
-        revision_dates = self.util.get_revision_date_for_file(
+        revision_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=False,
-                fallback_to_build_date=self.config.get("fallback_to_build_date"),
-            ),
-            locale=self.config.get("locale", "en"),
-            time_zone=self.config.get("time_zone", "UTC"),
+            )
         )
         revision_date = revision_dates[self.config["type"]]
 
@@ -166,7 +163,9 @@ def on_page_markdown(
         if self.config["type"] == "timeago":
             revision_date += revision_dates["iso_date"]
 
+        # Add to page meta information
         page.meta["git_revision_date_localized"] = revision_date
+        # Replace any occurances in markdown page
         markdown = re.sub(
             r"\{\{\s*git_revision_date_localized\s*\}\}",
             revision_date,
@@ -176,17 +175,17 @@ def on_page_markdown(
 
         # Creation date
         if self.config.get("enable_creation_date"):
-            creation_dates = self.util.get_creation_date_for_file(
+            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,
-                    fallback_to_build_date=self.config.get("fallback_to_build_date"),
-                ),
-                locale=self.config.get("locale", "en"),
-                time_zone=self.config.get("time_zone", "UTC"),
+                )
             )
             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"]
 
diff --git a/mkdocs_git_revision_date_localized_plugin/util.py b/mkdocs_git_revision_date_localized_plugin/util.py
@@ -29,7 +29,6 @@ class Util:
 
     def __init__(self, config={}):
         """Initialize utility class."""
-        self.fallback_enabled = False
         self.config = config
         self.repo_cache = {}
 
@@ -82,8 +81,7 @@ def _date_formats(
     def get_git_commit_timestamp(
             self,
             path: str,
-            is_first_commit: bool,
-            fallback_to_build_date: bool = False,
+            is_first_commit: bool = False
     ) -> int:
         """
         Get a list of commit dates in unix timestamp, starts with the most recent commit.
@@ -92,47 +90,50 @@ def get_git_commit_timestamp(
             is_first_commit (bool): if true, get the timestamp of the first commit,
                                     else, get that of the most recent commit.
             path (str): Location of a markdown file that is part of a Git repository.
+            is_first_commit (bool): retrieve commit timestamp when file was created.
 
         Returns:
-            list: commit dates in unix timestamp, starts with the most recent commit.
+            int: commit date in unix timestamp, starts with the most recent commit.
         """
-
         commit_timestamp = ""
 
         # perform git log operation
         try:
-            if not self.fallback_enabled:
-                # Retrieve author date in UNIX format (%at)
-                # https://git-scm.com/docs/git-log#Documentation/git-log.txt-ematem
-                realpath = os.path.realpath(path)
-                git = self._get_repo(realpath)
-                if is_first_commit:
-                    commit_timestamp = git.log(
-                        realpath, date="short", format="%at", diff_filter="A"
-                    )
-                else:
-                    commit_timestamp = git.log(
-                        realpath, date="short", format="%at", n=1
-                    )
+            # Retrieve author date in UNIX format (%at)
+            # https://git-scm.com/docs/git-log#Documentation/git-log.txt-ematem
+            # https://git-scm.com/docs/git-log#Documentation/git-log.txt---diff-filterACDMRTUXB82308203
+            realpath = os.path.realpath(path)
+            git = self._get_repo(realpath)
+            if is_first_commit:
+                # diff_filter="A" will select the commit that created the file
+                commit_timestamp = git.log(
+                    realpath, date="short", format="%at", diff_filter="A"
+                )
+            else:
+                commit_timestamp = git.log(
+                    realpath, date="short", format="%at", n=1
+                )
         except (InvalidGitRepositoryError, NoSuchPathError) as err:
-            if fallback_to_build_date:
+            if self.config.get('fallback_to_build_date'):
                 logger.warning(
                     "[git-revision-date-localized-plugin] Unable to find a git directory and/or git is not installed."
                     " Option 'fallback_to_build_date' set to 'true': Falling back to build date"
                 )
+                commit_timestamp = time.time()
             else:
                 logger.error(
                     "[git-revision-date-localized-plugin] Unable to find a git directory and/or git is not installed."
                     " To ignore this error, set option 'fallback_to_build_date: true'"
                 )
                 raise err
         except GitCommandError as err:
-            if fallback_to_build_date:
+            if self.config.get('fallback_to_build_date'):
                 logger.warning(
                     "[git-revision-date-localized-plugin] Unable to read git logs of '%s'. Is git log readable?"
                     " Option 'fallback_to_build_date' set to 'true': Falling back to build date"
                     % path
                 )
+                commit_timestamp = time.time()
             else:
                 logger.error(
                     "[git-revision-date-localized-plugin] Unable to read git logs of '%s'. "
@@ -141,11 +142,12 @@ def get_git_commit_timestamp(
                 )
                 raise err
         except GitCommandNotFound as err:
-            if fallback_to_build_date:
+            if self.config.get('fallback_to_build_date'):
                 logger.warning(
                     "[git-revision-date-localized-plugin] Unable to perform command: 'git log'. Is git installed?"
                     " Option 'fallback_to_build_date' set to 'true': Falling back to build date"
                 )
+                commit_timestamp = time.time()
             else:
                 logger.error(
                     "[git-revision-date-localized-plugin] Unable to perform command 'git log'. Is git installed?"
@@ -156,19 +158,16 @@ def get_git_commit_timestamp(
         # create timestamp
         if commit_timestamp == "":
             commit_timestamp = time.time()
-            if not self.fallback_enabled:
-                logger.warning(
-                    "[git-revision-date-localized-plugin] '%s' has no git logs, using current timestamp"
-                    % path
-                )
+            logger.warning(
+                "[git-revision-date-localized-plugin] '%s' has no git logs, using current timestamp"
+                % path
+            )
 
         return int(commit_timestamp)
 
-    def get_revision_date_for_file(
+    def get_date_formats_for_timestamp(
         self,
         commit_timestamp: int,
-        locale: str = "en",
-        time_zone: str = "UTC",
     ) -> Dict[str, str]:
         """
         Determine localized date variants for a given file.
@@ -183,7 +182,9 @@ def get_revision_date_for_file(
         """
 
         date_formats = self._date_formats(
-            unix_timestamp=commit_timestamp, time_zone=time_zone, locale=locale
+            unix_timestamp=commit_timestamp, 
+            time_zone=self.config.get("time_zone"),
+            locale=self.config.get("locale")
         )
 
         # Wrap in <span> for styling
@@ -195,33 +196,3 @@ def get_revision_date_for_file(
 
         return date_formats
 
-    def get_creation_date_for_file(
-        self,
-        commit_timestamp: int,
-        locale: str = "en",
-        time_zone: str = "UTC",
-    ) -> Dict[str, str]:
-        """
-        Determine localized date variants for a given file.
-
-        Args:
-            commit_timestamp (int): the first commit date in unix timestamp.
-            locale (str, optional): Locale code of language to use. Defaults to 'en'.
-            time_zone (str): Timezone database name (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
-
-        Returns:
-            dict: Localized date variants.
-        """
-
-        date_formats = self._date_formats(
-            unix_timestamp=commit_timestamp, time_zone=time_zone, locale=locale
-        )
-
-        # Wrap in <span> for styling
-        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
diff --git a/tests/fixtures/basic_project/docs/overrides_material_theme/partials/source-date.html b/tests/fixtures/basic_project/docs/overrides_material_theme/partials/source-date.html
@@ -0,0 +1,22 @@
+{% import "partials/language.html" as lang with context %}
+
+<!-- Last updated date -->
+{% set label = lang.t("source.revision.date") %}
+<hr />
+<div class="md-source-date">
+  <small>
+
+    <!-- mkdocs-git-revision-date-localized-plugin -->
+    {% if page.meta.git_revision_date_localized %}
+      {{ label }}: {{ page.meta.git_revision_date_localized }}
+
+      {% if page.meta.git_creation_date_localized %}
+        <br />Created: {{ page.meta.git_creation_date_localized }}
+      {% endif %}
+    
+    <!-- mkdocs-git-revision-date-plugin -->
+    {% elif page.meta.revision_date %}
+      {{ label }}: {{ page.meta.revision_date }}
+    {% endif %}
+  </small>
+</div>
diff --git a/tests/fixtures/basic_project/docs/overrides_mkdocs_theme/content.html b/tests/fixtures/basic_project/docs/overrides_mkdocs_theme/content.html
diff --git a/tests/fixtures/basic_project/mkdocs_theme_timeago_override.yml b/tests/fixtures/basic_project/mkdocs_theme_timeago_override.yml
@@ -0,0 +1,21 @@
+site_name: test gitrevisiondatelocalized_plugin
+use_directory_urls: true
+
+theme:
+    name: 'material'
+    custom_dir: docs/overrides_material_theme
+
+plugins:
+    - search
+    - git-revision-date-localized:
+        type: timeago
+        enable_creation_date: true
+
+
+nav:
+    - index.md
+    - first_page.md
+    - Subpage:
+        - subpage.md
+    - second_page.md
+    - page_with_tag.md
diff --git a/tests/fixtures/basic_project/mkdocs_with_override.yml b/tests/fixtures/basic_project/mkdocs_with_override.yml
@@ -3,7 +3,7 @@ use_directory_urls: true
 
 theme:
     name: mkdocs
-    custom_dir: docs/overrides
+    custom_dir: docs/overrides_mkdocs_theme
 
 plugins:
     - search
diff --git a/tests/test_builds.py b/tests/test_builds.py
@@ -200,14 +200,12 @@ 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(str(testproject_path / "docs"))
-    date_formats = repo.get_revision_date_for_file(
+    repo = Util(config=plugin_config)
+    date_formats = repo.get_date_formats_for_timestamp(
         commit_timestamp=repo.get_git_commit_timestamp(
             path=str(testproject_path / "docs/page_with_tag.md"),
             is_first_commit=False,
-            fallback_to_build_date=plugin_config.get("fallback_to_build_date"),
-        ),
-        locale=plugin_config.get("locale"),  # type: ignore
+        )
     )
 
     searches = [x in contents for x in date_formats.values()]
@@ -217,12 +215,10 @@ def validate_build(testproject_path, plugin_config: dict = {}):
         commit_timestamp=repo.get_git_commit_timestamp(
             path=str(testproject_path / "docs/page_with_tag.md"),
             is_first_commit=True,
-            fallback_to_build_date=plugin_config.get("fallback_to_build_date"),
         )
         assert commit_timestamp == 1500854705
-        date_formats = repo.get_revision_date_for_file(
+        date_formats = repo.get_date_formats_for_timestamp(
             commit_timestamp=commit_timestamp,
-            locale=plugin_config.get("locale"),  # type: ignore
         )
 
         searches = [x in contents for x in date_formats.values()]

Original file line number	Diff line number	Diff line change
`@@ -9,3 +9,4 @@`
`9`	`9`	`.git-revision-date-localized-plugin-iso_date { display: inline }`
`10`	`10`	`.git-revision-date-localized-plugin-timeago { display: none }`
`11`	`11`	`}`
	`12`	`+`