[BUGFIX] Allow Emails in anonymous links

linawolf · linawolf · commit 7f508d7de6c2 · 2023-09-03T09:11:51.000+02:00
depends on #573
diff --git a/packages/guides/resources/config/guides.php b/packages/guides/resources/config/guides.php
@@ -24,8 +24,10 @@
 use phpDocumentor\Guides\NodeRenderers\NodeRendererFactoryAware;
 use phpDocumentor\Guides\NodeRenderers\PreRenderers\PreNodeRendererFactory;
 use phpDocumentor\Guides\Parser;
+use phpDocumentor\Guides\ReferenceResolvers\AnchorReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DelegatingReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\DocReferenceResolver;
+use phpDocumentor\Guides\ReferenceResolvers\EmailReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\ExternalReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\InternalReferenceResolver;
 use phpDocumentor\Guides\ReferenceResolvers\IntersphinxReferenceResolver;
@@ -120,6 +122,10 @@
 
         ->set(ExternalReferenceResolver::class)
 
+        ->set(EmailReferenceResolver::class)
+
+        ->set(AnchorReferenceResolver::class)
+
         ->set(InternalReferenceResolver::class)
 
         ->set(DocReferenceResolver::class)
diff --git a/packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php b/packages/guides/src/ReferenceResolvers/AnchorReferenceResolver.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\ReferenceResolvers;
+
+use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
+use phpDocumentor\Guides\RenderContext;
+
+use function filter_var;
+
+use const FILTER_VALIDATE_EMAIL;
+
+/**
+ * Resolves references with an anchor URL.
+ *
+ * A link is an anchor if it starts with a hashtag
+ */
+class AnchorReferenceResolver implements ReferenceResolver
+{
+    public final const PRIORITY = -100;
+
+    public function resolve(LinkInlineNode $node, RenderContext $renderContext): bool
+    {
+        if (filter_var($node->getTargetReference(), FILTER_VALIDATE_EMAIL)) {
+            $node->setUrl('mailto:' . $node->getTargetReference());
+
+            return true;
+        }
+
+        return false;
+    }
+
+    public static function getPriority(): int
+    {
+        return self::PRIORITY;
+    }
+}
diff --git a/packages/guides/src/ReferenceResolvers/EmailReferenceResolver.php b/packages/guides/src/ReferenceResolvers/EmailReferenceResolver.php
@@ -0,0 +1,36 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\ReferenceResolvers;
+
+use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
+use phpDocumentor\Guides\RenderContext;
+
+use function filter_var;
+
+use const FILTER_VALIDATE_EMAIL;
+
+/**
+ * Resolves references with an embedded email address
+ */
+class EmailReferenceResolver implements ReferenceResolver
+{
+    public final const PRIORITY = -100;
+
+    public function resolve(LinkInlineNode $node, RenderContext $renderContext): bool
+    {
+        if (filter_var($node->getTargetReference(), FILTER_VALIDATE_EMAIL)) {
+            $node->setUrl('mailto:' . $node->getTargetReference());
+
+            return true;
+        }
+
+        return false;
+    }
+
+    public static function getPriority(): int
+    {
+        return self::PRIORITY;
+    }
+}
diff --git a/packages/guides/src/ReferenceResolvers/ExternalReferenceResolver.php b/packages/guides/src/ReferenceResolvers/ExternalReferenceResolver.php
@@ -7,10 +7,12 @@
 use phpDocumentor\Guides\Nodes\Inline\LinkInlineNode;
 use phpDocumentor\Guides\RenderContext;
 
+use function filter_var;
 use function parse_url;
 use function preg_match;
 use function str_starts_with;
 
+use const FILTER_VALIDATE_EMAIL;
 use const PHP_URL_SCHEME;
 
 /**
@@ -34,6 +36,12 @@ public function resolve(LinkInlineNode $node, RenderContext $renderContext): boo
             return true;
         }
 
+        if (filter_var($node->getTargetReference(), FILTER_VALIDATE_EMAIL)) {
+            $node->setUrl('mailto:' . $node->getTargetReference());
+
+            return true;
+        }
+
         $url = parse_url($node->getTargetReference(), PHP_URL_SCHEME);
         if ($url !== null && $url !== false && preg_match('/^' . self::SUPPORTED_SCHEMAS . '$/', $url)) {
             $node->setUrl($node->getTargetReference());
diff --git a/tests/Integration/tests/hyperlink-to-email/expected/index.html b/tests/Integration/tests/hyperlink-to-email/expected/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Some file</title>
+
+</head>
+<body>
+    <div class="section" id="some-file">
+    <h1>Some file</h1>
+
+            <p><a href="mailto:git@github.com">link to email</a></p>
+    </div>
+
+</body>
+</html>
diff --git a/tests/Integration/tests/hyperlink-to-email/input/index.rst b/tests/Integration/tests/hyperlink-to-email/input/index.rst
@@ -0,0 +1,4 @@
+Some file
+=========
+
+`link to email <git@github.com>`__
