add match_path option to filter files

.gitignore

@@ -201,11 +201,7 @@ dmypy.json
 # ####################################################################################
 # ## VisualStudioCode ######################
 # ##########################################
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
+.vscode
 *.code-workspace
 
 ### VisualStudioCode Patch ###

CHANGELOG.md

@@ -15,6 +15,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Removed -->
 
+## 0.13.0
+
+### Added
+
+- add `match_path` option which should be a regex pattern matching the path to your files within the docs_dir. See [issue #34](https://github.com/Guts/mkdocs-rss-plugin/issues/34) and the related [PR #43](https://github.com/Guts/mkdocs-rss-plugin/pull/43). Contributed by [Ryan Morshead](https://github.com/rmorshea/).
+
 ----
 
 ## 0.12.0

README.md

@@ -26,6 +26,7 @@ plugins:
       image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
       length: 20
       pretty_print: false
+      match_path: ".*"
 ```
 
 For further information, [see the user documentation](https://guts.github.io/mkdocs-rss-plugin/).

docs/usage/configuration.md

@@ -163,6 +163,18 @@ plugins:
 
 Default: `False`.
 
+### Filter pages
+
+This adds a `match_path` option which should be a regex pattern matching the path to your files within the `docs_dir`. For example if you had a blog under `docs/blog` where `docs_dir` is `docs` you might use:
+
+```yaml
+plugins:
+  - rss:
+      match_path: "blog/.*"
+```
+
+Default: `None`.
+
 ----
 
 ## Integration

mkdocs.yml

@@ -21,6 +21,7 @@ plugins:
         as_update: false
         datetime_format: "%Y-%m-%d %H:%M"
       image: https://upload.wikimedia.org/wikipedia/commons/thumb/4/43/Feed-icon.svg/128px-Feed-icon.svg.png
+      match_path: ".*"
       pretty_print: false
   - search
 

mkdocs_rss_plugin/customtypes.py

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

mkdocs_rss_plugin/plugin.py

@@ -49,6 +49,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)),
     )
 
     def __init__(self):
@@ -188,6 +189,7 @@ 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,
             )
         )
 
@@ -215,6 +217,7 @@ 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"),
             )
         )
 
@@ -224,6 +227,7 @@ 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,6 +6,7 @@
 
 # standard library
 import logging
+import re
 import ssl
 from datetime import date, datetime
 from email.utils import formatdate
@@ -457,11 +458,11 @@ def guess_locale(mkdocs_config: Config) -> str or None:
             return None
 
     @staticmethod
-    def filter_pages(pages: dict, attribute: str, length: int) -> list:
+    def filter_pages(pages: list, attribute: str, length: int, match_path: str) -> list:
         """Filter and return pages into a friendly RSS structure.
 
         :param pages: pages to filter
-        :type pages: dict
+        :type pages: list
         :param attribute: page attribute as filter variable
         :type attribute: str
         :param length: max number of pages to return
@@ -471,9 +472,12 @@ def filter_pages(pages: dict, attribute: str, length: int) -> list:
         :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/fixtures/docs/folder_ignored/page_should_be_ignored_by_pathmatch.md

@@ -0,0 +1,3 @@
+# Page to test feature
+
+See: <https://github.com/Guts/mkdocs-rss-plugin/pull/43/>

tests/test_config.py

@@ -17,9 +17,6 @@
 import unittest
 from pathlib import Path
 
-# mkdocs
-from mkdocs.structure.pages import Page
-
 # plugin target
 from mkdocs_rss_plugin.plugin import GitRssPlugin
 
@@ -61,6 +58,7 @@ def test_plugin_config_defaults(self):
             "image": None,
             "length": 20,
             "pretty_print": False,
+            "match_path": None,
         }
 
         # load
@@ -80,6 +78,7 @@ def test_plugin_config_image(self):
             "image": self.feed_image,
             "length": 20,
             "pretty_print": False,
+            "match_path": None,
         }
 
         # custom config