fix #229 allow date.created to get creation date (#237)

Author: Guts

docs/configuration.md

@@ -309,8 +309,8 @@ Basically, the plugin aims to retrieve creation and update dates from git log. B
 
 So, it's possible to use the dates manually specified into the [page metadata] through the [YAML frontmatter](https://www.mkdocs.org/user-guide/writing-your-docs/#meta-data).
 
-- `as_creation`: meta tag name to use as creation date. Default to `False`.
-- `as_update`: meta tag name to use as update date. Default to `False`.
+- `as_creation`: meta tag name (or a dot-separated tag name) to use as creation date. Default to `False`.
+- `as_update`: meta tag name (or a dot-separated tag name) to use as update date. Default to `False`.
 - `datetime_format`: datetime format. Default to `"%Y-%m-%d %H:%M"`.
 - `default_timezone`: timezone to use by default to make aware datetimes. Default to `UTC`. Introduced in version 1.3.0 with [PR 142](https://github.com/Guts/mkdocs-rss-plugin/pull/142).
 - `default_time`: time to use if page contains only a date. Useful to avoid the 'midnight syndrome' or have to specify hour in every single page. Default to `None`. 24h-clock format is expected: `%H:%M`. Example: `"14:20"`. Introduced in version 1.4.0 with [PR 145](https://github.com/Guts/mkdocs-rss-plugin/pull/145).
@@ -319,30 +319,60 @@ So, it's possible to use the dates manually specified into the [page metadata] t
 
 For example, in your `best_article.md` created in 2019, you can write the front-matter like this:
 
-```markdown
----
-title: "This page title is a perfect clickbait!"
-authors:
-  - "Julien M."
-date: "2020-10-22 17:18"
----
-
-# This plugin will change your MkDocs life
-
-Lorem ipsum [...]
-```
-
-So in your `mkdocs.yml` you will have:
-
-```yaml
-plugins:
-  - rss:
-      date_from_meta:
-        as_creation: "date"
-        as_update: false
-        datetime_format: "%Y-%m-%d %H:%M"
-        default_timezone: Europe/Paris
-```
+=== "tag name: `date`"
+
+    ```markdown hl_lines="5"
+    ---
+    title: "This page title is a perfect clickbait!"
+    authors:
+      - "Julien M."
+    date: "2020-10-22 17:18"
+    ---
+
+    # This plugin will change your MkDocs life
+
+    Lorem ipsum [...]
+    ```
+
+    So in your `mkdocs.yml` you will have:
+
+    ```yaml hl_lines="4-5"
+    plugins:
+      - rss:
+          date_from_meta:
+            as_creation: "date"
+            as_update: false
+            datetime_format: "%Y-%m-%d %H:%M"
+            default_timezone: Europe/Paris
+    ```
+
+=== "dot-separated tag name: `date.created`"
+
+    ```markdown hl_lines="6"
+    ---
+    title: "This page title is a perfect clickbait!"
+    authors:
+      - "Julien M."
+    date:
+      created: "2020-10-22 17:18"
+    ---
+
+    # This plugin will change your MkDocs life
+
+    Lorem ipsum [...]
+    ```
+
+    So in your `mkdocs.yml` you will have:
+
+    ```yaml hl_lines="4-5"
+    plugins:
+      - rss:
+          date_from_meta:
+            as_creation: "date.created"
+            as_update: false
+            datetime_format: "%Y-%m-%d %H:%M"
+            default_timezone: Europe/Paris
+    ```
 
 At the end, into the RSS you will get:
 
@@ -395,7 +425,7 @@ Default: `.*`.
 
 ### `url_parameters`: additional URL parameters
 
-This option allows you to add parameters to the URLs of the RSS feed items. It works as a dictionary of keys/values that is passed to [Python *urllib.parse.urlencode*](https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlencode).  
+This option allows you to add parameters to the URLs of the RSS feed items. It works as a dictionary of keys/values that is passed to [Python *urllib.parse.urlencode*](https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlencode).
 One possible use case is the addition of [Urchin Tracking Module (UTM) parameters](https://en.wikipedia.org/wiki/UTM_parameters):
 
 ```yaml

mkdocs_rss_plugin/util.py

@@ -12,7 +12,7 @@
 from email.utils import format_datetime
 from mimetypes import guess_type
 from pathlib import Path
-from typing import Iterable, Optional, Tuple
+from typing import Any, Iterable, Optional, Tuple, Union
 from urllib import request
 from urllib.error import HTTPError, URLError
 from urllib.parse import urlencode, urlparse, urlunparse
@@ -139,6 +139,28 @@ def build_url(self, base_url: str, path: str, args_dict: dict = None) -> str:
             url_parts[4] = urlencode(args_dict)
         return urlunparse(url_parts)
 
+    def get_value_from_dot_key(self, data: dict, dot_key: Union[str, bool]) -> Any:
+        """
+        Retrieves a value from a dictionary using a dot notation key.
+
+        :param data: The dictionary from which to retrieve the value.
+        :type data: dict
+        :param dot_key: The key in dot notation to specify the path in the dictionary.
+        :type dot_key: Union[str, bool]
+
+        :return: The value retrieved from the dictionary, or None if the key
+        does not exist.
+        :rtype: Any
+        """
+        if not isinstance(dot_key, str):
+            return data.get(dot_key)
+        for key in dot_key.split("."):
+            if isinstance(data, dict) and key in data:
+                data = data[key]
+            else:
+                return None
+        return data
+
     def get_file_dates(
         self,
         in_page: Page,
@@ -174,10 +196,13 @@ def get_file_dates(
 
         # if enabled, try to retrieve dates from page metadata
         if not self.use_git or (
-            source_date_creation != "git" and in_page.meta.get(source_date_creation)
+            source_date_creation != "git"
+            and self.get_value_from_dot_key(in_page.meta, source_date_creation)
         ):
             dt_created = self.get_date_from_meta(
-                date_metatag_value=in_page.meta.get(source_date_creation),
+                date_metatag_value=self.get_value_from_dot_key(
+                    in_page.meta, source_date_creation
+                ),
                 meta_datetime_format=meta_datetime_format,
                 meta_datetime_timezone=meta_default_timezone,
                 meta_default_time=meta_default_time,
@@ -195,10 +220,13 @@ def get_file_dates(
                 )
 
         if not self.use_git or (
-            source_date_update != "git" and in_page.meta.get(source_date_update)
+            source_date_update != "git"
+            and self.get_value_from_dot_key(in_page.meta, source_date_update)
         ):
             dt_updated = self.get_date_from_meta(
-                date_metatag_value=in_page.meta.get(source_date_update),
+                date_metatag_value=self.get_value_from_dot_key(
+                    in_page.meta, source_date_update
+                ),
                 meta_datetime_format=meta_datetime_format,
                 meta_datetime_timezone=meta_default_timezone,
                 meta_default_time=meta_default_time,

tests/fixtures/docs/page_with_meta_date_in_dot_key.md

@@ -0,0 +1,18 @@
+---
+title: Page with meta date in dot key
+authors:
+    - Guts
+    - Tim Vink
+    - liang2kl
+date:
+    created: 2023-10-07 10:20
+update: 2023-10-08 10:20
+description: First test page of mkdocs-rss-plugin test suite
+image: "https://svgsilh.com/png-512/97849.png"
+tags:
+    - test
+---
+
+# Test page with meta
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

tests/fixtures/mkdocs_dates_overridden_in_dot_key.yml

@@ -0,0 +1,27 @@
+# Project information
+site_name: MkDocs RSS Plugin - TEST
+site_description: Basic setup to test against MkDocs RSS plugin
+site_author: Julien Moura (Guts)
+site_url: https://guts.github.io/mkdocs-rss-plugin
+copyright: 'Guts - In Geo Veritas'
+
+# Repository
+repo_name: 'guts/mkdocs-rss-plugin'
+repo_url: 'https://github.com/guts/mkdocs-rss-plugin'
+
+use_directory_urls: true
+
+plugins:
+  - rss:
+      date_from_meta:
+        # date location given as dot key
+        as_creation: "date.created"
+        as_update: "update"
+        datetime_format: "%Y-%m-%d %H:%M"
+
+theme:
+  name: readthedocs
+
+# Extensions to enhance markdown
+markdown_extensions:
+  - meta

tests/test_build.py

@@ -510,6 +510,35 @@ def test_bad_config(self):
             self.assertEqual(cli_result.exit_code, 1)
             self.assertIsNotNone(cli_result.exception)
 
+    def test_date(self):
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            cli_result = self.build_docs_setup(
+                testproject_path="docs",
+                mkdocs_yml_filepath=Path(
+                    "tests/fixtures/mkdocs_dates_overridden_in_dot_key.yml"
+                ),
+                output_path=tmpdirname,
+                strict=True,
+            )
+            self.assertEqual(cli_result.exit_code, 0)
+            self.assertIsNone(cli_result.exception)
+
+            feed_rss_created = feedparser.parse(
+                Path(tmpdirname) / "feed_rss_created.xml"
+            )
+            for page in feed_rss_created.entries:
+                if page.title == "Page with meta date in dot key":
+                    self.assertEqual(page.published, "Sat, 07 Oct 2023 10:20:00 +0000")
+                    break
+
+            feed_rss_updated = feedparser.parse(
+                Path(tmpdirname) / "feed_rss_updated.xml"
+            )
+            for page in feed_rss_updated.entries:
+                if page.title == "Page with meta date in dot key":
+                    self.assertEqual(page.published, "Sun, 08 Oct 2023 10:20:00 +0000")
+                    break
+
     def test_bad_date_format(self):
         # add a new page without tracking it
         md_str = """---\ndate: 13 April 2022\n---\n\n# This page is dynamically created for test purposes\n\nHi!\n

tests/test_rss_util.py

@@ -95,6 +95,41 @@ def test_remote_image_none(self):
         )
         self.assertIsNone(img_length)
 
+    def test_get_value_from_dot_key(self):
+        param_list = [
+            {
+                "meta": {"date": "2021-09-01"},
+                "value_location": "date",
+                "value": "2021-09-01",
+            },
+            {
+                "meta": {"date": {"created": "2021-09-01"}},
+                "value_location": "date.created",
+                "value": "2021-09-01",
+            },
+            {
+                "meta": {"date": "2021-09-01"},
+                "value_location": "date.created",
+                "value": None,
+            },
+            {
+                "meta": {True: "bool_as_key"},
+                "value_location": True,
+                "value": "bool_as_key",
+            },
+            {
+                "meta": {"date": "2021-09-01"},
+                "value_location": True,
+                "value": None,
+            },
+        ]
+        for param in param_list:
+            with self.subTest(param=param):
+                result = self.plg_utils.get_value_from_dot_key(
+                    param["meta"], param["value_location"]
+                )
+                self.assertEqual(result, param["value"])
+
 
 # ##############################################################################
 # ##### Stand alone program ########