Replace new reference by native url substitution

Author: alamirault

src/KernelFactory.php

@@ -44,7 +44,8 @@ public static function createKernel(BuildConfig $buildConfig, ?UrlChecker $urlCh
             new SymfonyHTMLFormat(
                 $configuration->getTemplateRenderer(),
                 $configuration->getFormat(),
-                $urlChecker
+                $urlChecker,
+                $buildConfig->getSymfonyVersion()
             )
         );
 
@@ -103,7 +104,6 @@ private static function getReferences(BuildConfig $buildConfig): array
     {
         return [
             new SymfonyReferences\ClassReference($buildConfig->getSymfonyRepositoryUrl()),
-            new SymfonyReferences\GithubReference($buildConfig->getSymfonyVersion()),
             new SymfonyReferences\MethodReference($buildConfig->getSymfonyRepositoryUrl()),
             new SymfonyReferences\NamespaceReference($buildConfig->getSymfonyRepositoryUrl()),
             new SymfonyReferences\PhpFunctionReference($buildConfig->getPhpDocUrl()),

src/Reference/GithubReference.php

@@ -25,23 +25,27 @@ class SpanNodeRenderer extends AbstractSpanNodeRenderer
     private $decoratedSpanNodeRenderer;
     /** @var UrlChecker|null */
     private $urlChecker;
+    private $symfonyVersion;
 
     public function __construct(
         Environment $environment,
         SpanNode $span,
         BaseSpanNodeRenderer $decoratedSpanNodeRenderer,
-        ?UrlChecker $urlChecker = null
-    ) {
+        ?UrlChecker $urlChecker = null,
+        string $symfonyVersion = null
+    )
+    {
         parent::__construct($environment, $span);
 
         $this->decoratedSpanNodeRenderer = $decoratedSpanNodeRenderer;
         $this->urlChecker = $urlChecker;
+        $this->symfonyVersion = $symfonyVersion;
     }
 
     /** @inheritDoc */
     public function link(?string $url, string $title, array $attributes = []): string
     {
-        $url = (string)$url;
+        $url = (string) $url;
 
         if (
             $this->urlChecker &&
@@ -55,6 +59,10 @@ public function link(?string $url, string $title, array $attributes = []): strin
             $attributes = $this->addAttributesForUnsafeUrl($attributes);
         }
 
+        if (null !== $this->symfonyVersion) {
+            $url = u($url)->replace('{version}', $this->symfonyVersion)->toString();
+        }
+
         return $this->decoratedSpanNodeRenderer->link($url, $title, $attributes);
     }
 

src/Renderers/SpanNodeRenderer.php

@@ -29,12 +29,14 @@ final class SymfonyHTMLFormat implements Format
     private $htmlFormat;
     /** @var UrlChecker|null */
     private $urlChecker;
+    private $symfonyVersion;
 
-    public function __construct(TemplateRenderer $templateRenderer, Format $HTMLFormat, ?UrlChecker $urlChecker = null)
+    public function __construct(TemplateRenderer $templateRenderer, Format $HTMLFormat, ?UrlChecker $urlChecker = null, string $symfonyVersion = null)
     {
         $this->templateRenderer = $templateRenderer;
         $this->htmlFormat = $HTMLFormat;
         $this->urlChecker = $urlChecker;
+        $this->symfonyVersion = $symfonyVersion;
     }
 
     public function getFileExtension(): string
@@ -69,7 +71,8 @@ function (SpanNode $node) {
                     $node->getEnvironment(),
                     $node,
                     new BaseSpanNodeRenderer($node->getEnvironment(), $node, $this->templateRenderer),
-                    $this->urlChecker
+                    $this->urlChecker,
+                    $this->symfonyVersion
                 );
             }
         );

src/SymfonyHTMLFormat.php

@@ -143,6 +143,10 @@ public function parserUnitBlockProvider()
             'blockName' => 'nodes/figure',
         ];
 
+        yield 'span-link' => [
+            'blockName' => 'nodes/span-link',
+        ];
+
         yield 'title' => [
             'blockName' => 'nodes/title',
         ];
@@ -211,10 +215,6 @@ public function parserUnitBlockProvider()
             'blockName' => 'references/class',
         ];
 
-        yield 'github-reference' => [
-            'blockName' => 'references/github',
-        ];
-
         yield 'namespace-reference' => [
             'blockName' => 'references/namespace',
         ];

tests/IntegrationTest.php

@@ -0,0 +1,3 @@
+<p><a href="https://github.com/symfony/amazon-sns-notifier/blob/4.0/README.md" class="reference external" rel="external noopener noreferrer" target="_blank">README file with version substitution</a></p>
+
+<p><a href="https://github.com/symfony/amazon-sns-notifier/blob/version/README.md" class="reference external" rel="external noopener noreferrer" target="_blank">README file without version substitution</a></p>

tests/fixtures/expected/blocks/nodes/span-link.html

@@ -0,0 +1,3 @@
+`README file with version substitution <https://github.com/symfony/amazon-sns-notifier/blob/{version}/README.md>`_
+
+`README file without version substitution <https://github.com/symfony/amazon-sns-notifier/blob/version/README.md>`_