Fix #11 properly and add tests

* Add test dependencies and document how to install and run tests
* Add regression tests for different types of links
* Fix #11 properly: Test for `#` prefix in links
    * Rolls back the broken fix in 8d4b5ee
    *Fixes #11 by checking for a hash prefix in closure code

README.md

@@ -24,6 +24,20 @@ Install the package with pip:
 pip install mkdocs-embed-external-markdown
 ```
 
+### Installation for development
+
+To run the tests, first install the package and its test dependencies with pip:
+
+```shell
+pip install .[test]
+```
+
+You can now run the tests in `tests/` with `pytest`:
+
+```shell
+python -m pytest tests/
+```
+
 ## Configuration
 
 Enable the plugin in your `mkdocs.yml` file:

external_markdown/plugin.py

@@ -9,7 +9,7 @@
 
 # Pre-compile regular expressions
 SECTION_LEVEL_REGEX = re.compile("^#+ ", re.IGNORECASE)
-LINK_PATTERN_REGEX = re.compile(r"\[(?P<alt_text>[^\]]*)\]\([^#](?P<link_url>[^\)]*)\)", re.MULTILINE | re.IGNORECASE)
+LINK_PATTERN_REGEX = re.compile(r"\[(?P<alt_text>[^\]]*)\]\((?P<link_url>[^\)]*)\)", re.MULTILINE | re.IGNORECASE)
 
 logger = logging.getLogger("mkdocs.plugins")
 
@@ -106,7 +106,9 @@ def update_relative_links(self, markdown: str, base_url: str) -> str:
         """
 
         def replace_link(match):
-            link_url = urljoin(base_url, match.group("link_url"))
+            link_url = str(match.group("link_url"))
+            if not link_url.startswith("#"):
+                link_url = urljoin(base_url, link_url)
             return f'[{match.group("alt_text")}]({link_url})'
 
         return LINK_PATTERN_REGEX.sub(replace_link, markdown)

pyproject.toml

@@ -32,6 +32,10 @@ dependencies = [
 Source = 'https://github.com/fire1ce/pypi-test'
 
 [project.optional-dependencies]
+test = [
+  "pytest>=7.4.3",
+  "mkdocs>=1.5.3",
+]
 
 [project.scripts]
 

requirements.txt

@@ -1,2 +1,4 @@
 Jinja2==3.1.2
 requests==2.31.0
+pytest[test]==7.4.3
+mkdocs[test]==1.5.3

tests/external-markdown/test_plugin.py

@@ -0,0 +1,39 @@
+import pytest
+
+from external_markdown.plugin import EmbedExternalMarkdown
+
+BASE_URL = "https://BASEURL/"
+BASE_FILE = "https://BASEURL/FILE.md"
+TEST_DATA = [
+    (
+        "external link",
+        "https://github.com",
+        "https://github.com"),
+    (
+        "external link with anchor",
+        "https://ansible-docs.readthedocs.io/zh/stable-2.0/rst/playbooks_variables.html#using-variables-about-jinja2",
+        "https://ansible-docs.readthedocs.io/zh/stable-2.0/rst/playbooks_variables.html#using-variables-about-jinja2",
+    ),
+    (
+        "anchor",
+        "#links",
+        "#links"),
+    (
+        "local link",
+        "page.md",
+        f"{BASE_URL}page.md"),
+    (
+        "local link with anchor",
+        "page.md#test-subsection",
+        f"{BASE_URL}page.md#test-subsection",
+    ),
+]
+
+
+class TestEmbedExternalMarkdown:
+    @pytest.mark.parametrize("label,link_url,expected_url", TEST_DATA)
+    def test_update_relative_links_external(self, label, link_url, expected_url):
+        # Regression tests for #11
+        link = f"[{label}]({link_url})"
+        expected = f"[{label}]({expected_url})"
+        assert EmbedExternalMarkdown().update_relative_links(link, BASE_FILE) == expected