Merge pull request #49 from pauloribeiro-codacy/fix/filter-match-path

fix: Completely skip pages excluded by match_path

.gitignore

@@ -184,6 +184,9 @@ venv.bak/
 # Rope project settings
 .ropeproject
 
+# JetBrains project settings
+.idea
+
 # mkdocs documentation
 /site
 

docs/usage/configuration.md

@@ -173,7 +173,7 @@ plugins:
       match_path: "blog/.*"
 ```
 
-Default: `None`.
+Default: `.*`.
 
 ----
 

mkdocs_rss_plugin/customtypes.py

@@ -22,4 +22,3 @@ class PageInformation(NamedTuple):
     description: str = None
     image: str = None
     url_full: str = None
-    src_path: str = None

mkdocs_rss_plugin/plugin.py

@@ -9,6 +9,7 @@
 from copy import deepcopy
 from email.utils import formatdate
 from pathlib import Path
+from re import compile
 
 # 3rd party
 from jinja2 import Environment, FileSystemLoader, select_autoescape
@@ -49,7 +50,7 @@ class GitRssPlugin(BasePlugin):
         ("image", config_options.Type(str, default=None)),
         ("length", config_options.Type(int, default=20)),
         ("pretty_print", config_options.Type(bool, default=False)),
-        ("match_path", config_options.Type(str, default=None)),
+        ("match_path", config_options.Type(str, default=".*")),
     )
 
     def __init__(self):
@@ -105,6 +106,9 @@ def on_config(self, config: config_options.Config) -> dict:
         if self.config.get("image"):
             base_feed["logo_url"] = self.config.get("image")
 
+        # pattern to match pages included in output
+        self.match_path_pattern = compile(self.config.get("match_path"))
+
         # date handling
         if self.config.get("date_from_meta") is not None:
             self.src_date_created = self.config.get("date_from_meta").get(
@@ -166,6 +170,10 @@ def on_page_markdown(
         Returns:
             str: Markdown source text of page as string
         """
+        # skip pages that don't match the config var match_path
+        if not self.match_path_pattern.match(page.file.src_path):
+            return
+
         # retrieve dates from git log
         page_dates = self.util.get_file_dates(
             in_page=page,
@@ -189,7 +197,6 @@ def on_page_markdown(
                     in_page=page, base_url=config.get("site_url", __uri__)
                 ),
                 url_full=page.canonical_url,
-                src_path=page.file.src_path,
             )
         )
 
@@ -217,7 +224,6 @@ def on_post_build(self, config: config_options.Config) -> dict:
                 pages=self.pages_to_filter,
                 attribute="created",
                 length=self.config.get("length", 20),
-                match_path=self.config.get("match_path"),
             )
         )
 
@@ -227,7 +233,6 @@ def on_post_build(self, config: config_options.Config) -> dict:
                 pages=self.pages_to_filter,
                 attribute="updated",
                 length=self.config.get("length", 20),
-                match_path=self.config.get("match_path"),
             )
         )
 

mkdocs_rss_plugin/util.py

@@ -6,7 +6,6 @@
 
 # standard library
 import logging
-import re
 import ssl
 from datetime import date, datetime
 from email.utils import formatdate
@@ -458,7 +457,7 @@ def guess_locale(mkdocs_config: Config) -> str or None:
             return None
 
     @staticmethod
-    def filter_pages(pages: list, attribute: str, length: int, match_path: str) -> list:
+    def filter_pages(pages: list, attribute: str, length: int) -> list:
         """Filter and return pages into a friendly RSS structure.
 
         :param pages: pages to filter
@@ -472,12 +471,9 @@ def filter_pages(pages: list, attribute: str, length: int, match_path: str) -> l
         :rtype: list
         """
         filtered_pages = []
-        path_pattern = re.compile(match_path) if match_path else None
         for page in sorted(
             pages, key=lambda page: getattr(page, attribute), reverse=True
         )[:length]:
-            if path_pattern and not path_pattern.match(page.src_path):
-                continue
             filtered_pages.append(
                 {
                     "authors": page.authors,

tests/test_config.py

@@ -58,7 +58,7 @@ def test_plugin_config_defaults(self):
             "image": None,
             "length": 20,
             "pretty_print": False,
-            "match_path": None,
+            "match_path": ".*",
         }
 
         # load
@@ -78,7 +78,7 @@ def test_plugin_config_image(self):
             "image": self.feed_image,
             "length": 20,
             "pretty_print": False,
-            "match_path": None,
+            "match_path": ".*",
         }
 
         # custom config