Merge pull request #20 from Neoteroi/v0.1.2

v0.1.2

.gitignore

@@ -11,3 +11,5 @@ styles/*.css
 styles/*.css.map
 __*.html
 __file_out.py
+
+docs/res/contribs-new.html

CHANGELOG.md

@@ -5,8 +5,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.2] - 2022-10-04
+- Corrects the pattern handling name and email for the `contribs` plugin
+- Adds tests for the `contribs` plugin
+
 ## [0.1.1] - 2022-10-04
-- Corrects bug in the `contributors` plugin, causing failures in certain CI/CD
+- Corrects bug in the `contribs` plugin, causing failures in certain CI/CD
   solutions and improves its safety and performance (removes `shell=True`!)
 - Adds option to apply a class to specific contributors, for simpler styling
 - Minor improvements to styles

docs/res/contribs-01.html

@@ -0,0 +1,3 @@
+# Hello World
+
+Some sentence.

neoteroi/contribs/__init__.py

@@ -9,6 +9,7 @@
 import logging
 from datetime import datetime
 from pathlib import Path
+from subprocess import CalledProcessError
 from typing import List, Optional
 
 from mkdocs.config import config_options as c
@@ -125,10 +126,11 @@ def _set_contributors(self, markdown: str, page: Page) -> str:
     def on_page_markdown(self, markdown, *args, **kwargs):
         try:
             markdown = self._set_contributors(markdown, kwargs["page"])
-        except ValueError:
+        except (CalledProcessError, ValueError) as operation_error:
             logger.error(
                 "Failed to display contributors list for page: %s",
                 kwargs["page"].title,
+                exc_info=operation_error,
             )
             pass
         return markdown

neoteroi/contribs/git.py

@@ -11,7 +11,7 @@
 
 class GitContributionsReader(ContributionsReader):
 
-    _name_email_rx = re.compile(r"(?P<name>[\w\s]+)\s<(?P<email>[^\>]+)>")
+    _name_email_rx = re.compile(r"(?P<name>[^\<]+)<(?P<email>[^\>]+)>")
 
     def _decode(self, value: bytes) -> str:
         try:
@@ -22,10 +22,10 @@ def _decode(self, value: bytes) -> str:
     def _parse_name_and_email(self, name_and_email) -> Tuple[str, str]:
         match = self._name_email_rx.search(name_and_email)
         if match:
-            name = match.groupdict()["name"]
-            email = match.groupdict()["email"]
+            name = match.groupdict()["name"].strip()
+            email = match.groupdict()["email"].strip()
         else:
-            name, email = ""
+            name, email = ("", "")
         return name, email
 
     def parse_committers(self, output: str) -> Iterable[Contributor]:

setup.py

@@ -8,7 +8,7 @@ def readme():
 
 setup(
     name="neoteroi-mkdocs",
-    version="0.1.1",
+    version="0.1.2",
     description="Plugins for MkDocs and Python Markdown",
     long_description=readme(),
     long_description_content_type="text/markdown",

tests/test_contribs.py

@@ -1,5 +1,10 @@
+import textwrap
+
 import pytest
+from mkdocs.structure.files import File
+from mkdocs.structure.pages import Page
 
+from neoteroi.contribs import ContribsPlugin
 from neoteroi.contribs.domain import Contributor
 from neoteroi.contribs.git import GitContributionsReader
 
@@ -11,6 +16,10 @@
             "     2\tRoberto Prevato <[email protected]>\n",
             [Contributor("Roberto Prevato", "[email protected]", 2)],
         ],
+        [
+            "     2\tRoberto Prevato (RP) <[email protected]>\n",
+            [Contributor("Roberto Prevato (RP)", "[email protected]", 2)],
+        ],
         [
             (
                 "     14\tRoberto Prevato <[email protected]>\n"
@@ -27,3 +36,102 @@ def test_parse_contributors(value, expected_result):
     reader = GitContributionsReader()
     contributors = list(reader.parse_committers(value))
     assert contributors == expected_result
+
+
+def _get_contribs_config():
+    return {
+        "contributors_label": "Contributors",
+        "last_modified_label": "Last modified on",
+        "show_last_modified_time": True,
+        "show_contributors_title": False,
+        "time_format": "%Y-%m-%d %H:%M:%S",
+    }
+
+
+def test_contribs_plugin_success():
+    """
+    Tests a successful scenario.
+    """
+    handler = ContribsPlugin()
+    handler.config = _get_contribs_config()
+
+    example = textwrap.dedent(
+        """
+        # Hello World!
+
+        Lorem ipsum dolor sit amet.
+
+        """.strip(
+            "\n"
+        )
+    )
+
+    result = handler.on_page_markdown(
+        example,
+        page=Page(
+            "Example",
+            File(
+                path="res/contribs-01.html",
+                src_dir="tests/res",
+                dest_dir="tests",
+                use_directory_urls=True,
+            ),
+            {},
+        ),
+    )
+
+    assert result is not None
+    assert (
+        result
+        == """# Hello World!
+
+Lorem ipsum dolor sit amet.
+
+<div class="nt-contribs"><p class="nt-mod-time">Last modified on: 2022-10-04 21"""
+        + """:01:05</p><div class="nt-contributors"><div class="nt-contributor """
+        + """nt-group-0" title="Charlie Brown &lt;[email protected]&gt;"""
+        + """ (1)"><span class="nt-initials">CB</span></div><div class="nt-cont"""
+        + """ributor nt-group-1" title="Sally Brown (SB) &lt;sally.brown@exampl"""
+        + """e.org&gt; (1)"><span class="nt-initials">SB</span></div></div></di"""
+        + """v>"""
+    )
+
+
+def test_contribs_plugin_new_file_ignore():
+    """
+    Tests the scenario of a new file that is created while developing and is not
+    committed, yet.
+    """
+    handler = ContribsPlugin()
+    handler.config = _get_contribs_config()
+
+    example = textwrap.dedent(
+        """
+        # Hello World!
+
+        Lorem ipsum dolor sit amet.
+
+        """.strip(
+            "\n"
+        )
+    )
+
+    with open("docs/res/contribs-new.html", mode="wt", encoding="utf8") as new_file:
+        new_file.write(example)
+
+    result = handler.on_page_markdown(
+        example,
+        page=Page(
+            "Example",
+            File(
+                path="res/contribs-new.html",
+                src_dir="tests/res",
+                dest_dir="tests",
+                use_directory_urls=True,
+            ),
+            {},
+        ),
+    )
+
+    assert result is not None
+    assert result == example